https://github.com/materials-data-science-and-informatics/fair-python-cookiecutter-demo
Live demo to demonstrate a repository created from the fair-python-cookiecutter template.
https://github.com/materials-data-science-and-informatics/fair-python-cookiecutter-demo
cookiecutter cookiecutter-python cookiecutter-template fair python
Last synced: 3 months ago
JSON representation
Live demo to demonstrate a repository created from the fair-python-cookiecutter template.
- Host: GitHub
- URL: https://github.com/materials-data-science-and-informatics/fair-python-cookiecutter-demo
- Owner: Materials-Data-Science-and-Informatics
- License: unlicense
- Created: 2023-06-15T10:09:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-07T14:24:56.000Z (10 months ago)
- Last Synced: 2025-03-07T15:29:32.083Z (10 months ago)
- Topics: cookiecutter, cookiecutter-python, cookiecutter-template, fair, python
- Language: Python
- Homepage: https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter
- Size: 2.72 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Authors: AUTHORS.md
- Codemeta: codemeta.json
Awesome Lists containing this project
README
[
](https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter-demo)
[
](https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter-demo/main/coverage)
[
](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo/actions/workflows/ci.yml)
# fair-python-cookiecutter-demo
----
**:warning: TODO: Complete project setup :construction:**
This is a Python project generated from the
[fair-python-cookiecutter](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter)
template.
**TODO:** To finalize the project setup, please carefully read and follow the instructions in the
[developer guide](https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter/latest/dev_guide).
A copy of the guide is included in your project in `docs/dev_guide.md`.
----
TODO - add description
**:construction: TODO: Write a paragraph summarizing what this project is about.**
## Installation
**TODO: check that the installation instructions work**
This project works with Python > 3.9.
```bash
pip install git+ssh://git@github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo.git
```
## Getting Started
**TODO: provide a minimal working example**
## Troubleshooting
### When I try installing the package, I get an `IndexError: list index out of range`
Make sure you have `pip` > 21.2 (see `pip --version`), older versions have a bug causing
this problem. If the installed version is older, you can upgrade it with
`pip install --upgrade pip` and then try again to install the package.
**You can find more information on using and contributing to this repository in the
[documentation](https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter-demo/main).**
## How to Cite
If you want to cite this project in your scientific work,
please use the [citation file](https://citation-file-format.github.io/)
in the [repository](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo/blob/main/CITATION.cff).
## Acknowledgements
We kindly thank all
[authors and contributors](https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter-demo/latest/credits).
**TODO: relevant organizational acknowledgements (employers, funders)**