Fair Code

A template to make your software more FAIR compliant with the TU Delft Software Guidelines

How to Use

This template requires Python 3.8+

New Project

If starting a new project from scratch, you can follow these steps:

1. Use pipx to install copier, and render the template.

# intalling copier
pipx install copier

2. Start a new software project using this template:

copier copy https://github.com/manuGil/fair-code.git <path/to/project-directory>

3. Finally, initize a Git repository in your project directory:

cd <path/to/project-directory>
git init
git add . 
git commit -m 'initial commit'

Existing Project

If you have an existing project and want to use this template, you can use the following command:

1. Use pipx to install copier, and render the template.

# intalling copier
pipx install copier

2. Make sure your existing project is a Git repository. If not, you can initialize it with:

cd <path/to/existing-project-directory>
git init    
git add .
git commit -m 'initial commit'

3. apply the template to your existing project:

copier copy https://github.com/manuGil/fair-code.git <path/to/exiting-project-directory> 

4. Finally, commit the changes to your exising project:

git add . 
git commit -m 'apply template to existing project'

Contributing

Read our guidelines to know how to be part of the development of this template.

License

This template is freely available under an Apache License 2.0

Acknowledgements

• SS NES Meta Template
• Serious Scaffold Python
• Make a README