-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Prati28 <[email protected]>
- Loading branch information
Showing
8 changed files
with
333 additions
and
126 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,20 @@ | ||
| { | ||
| "template": "D:\\open-source\\gsoc\\final\\cookiecutter-python", | ||
| "commit": "88967f43af9799dfa0ad04b2908d7f40259c02d2", | ||
| "template": "https://github.com/elixir-cloud-aai/cookiecutter-python", | ||
| "commit": "43f9bd92eaf21557e87d3932524fe5ffb6fd7ef4", | ||
| "checkout": null, | ||
| "context": { | ||
| "cookiecutter": { | ||
| "author_name": "Elixir Cloud AAI", | ||
| "author_name": "ELIXIR Cloud AAI", | ||
| "author_email": "[email protected]", | ||
| "development_status": "Beta", | ||
| "short_description": "File Handler Utilizing TUS and Minio (S3 Storage) with DRS Filer Integration", | ||
| "development_status": "Alpha", | ||
| "short_description": "File handler utilizing TUS and MinIO with DRS-Filer integration", | ||
| "project_name": "tus-storagehandler", | ||
| "project_slug": "tus_storagehandler", | ||
| "github_username": "elixir-cloud-aai", | ||
| "python_version": "3.11", | ||
| "add_script": "y", | ||
| "year": "2024", | ||
| "_template": "D:\\open-source\\gsoc\\final\\cookiecutter-python" | ||
| "_template": "https://github.com/elixir-cloud-aai/cookiecutter-python" | ||
| } | ||
| }, | ||
| "directory": null | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| # Python Cookiecutter Template | ||
|
|
||
| This is a Cookiecutter template for creating a Python project with Poetry, | ||
| including configurations for various project settings. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Introduction](#introduction) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Configurations](#configurations) | ||
| - [Package manager - Poetry](#package-manager---poetry) | ||
| - [Linters and formatters - Ruff](#linters-and-formatters---ruff) | ||
| - [Spell checker - Typos](#spell-checker---typos) | ||
| - [Static type checker - Mypy](#static-type-checker---mypy) | ||
| - [Documentation - Sphinx](#documentation---sphinx) | ||
| - [Testing - pytest and pytest-cov](#testing---pytest-and-pytest-cov) | ||
| - [CI/CD - GitHub Actions](#cicd---github-actions) | ||
| - [Disclaimer](#disclaimer) | ||
| - [Contributing](#contributing) | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [Versioning](#versioning) | ||
| - [License](#license) | ||
| - [Contact](#contact) | ||
|
|
||
| ## Usage | ||
|
|
||
| 1. **Install cruft** (if you haven't already): | ||
|
|
||
| ```sh | ||
| pip install cruft | ||
| ``` | ||
|
|
||
| 2. **Generate a New Project**: | ||
|
|
||
| ```sh | ||
| cruft create https://github.com/elixir-cloud-aai/cookiecutter-python.git | ||
| ``` | ||
|
|
||
| ### Don't wanna use cruft? | ||
|
|
||
| You can also use the `cookiecutter` command directly: | ||
|
|
||
| 1. **Install cookiecutter** (if you haven't already): | ||
|
|
||
| ```sh | ||
| pip install cookiecutter | ||
| ``` | ||
|
|
||
| 2. **Generate a New Project**: | ||
|
|
||
| ```sh | ||
| cookiecutter gh:elixir-cloud-aai/cookiecutter-python | ||
| ``` | ||
|
|
||
| > **Note**: If you're using just `cookiecutter`, manually remove | ||
| `update-template` job from `update.yaml` github action workflow file as | ||
| `cookiecutter` doesn't support autosync like cruft. | ||
|
|
||
| ## Configurations | ||
|
|
||
| ### Package manager - Poetry | ||
|
|
||
| This project uses [Poetry][poetry-org] as a package manager. Check out the | ||
| commands at the [official documentation][poetry-docs]. | ||
|
|
||
| ### Linters and formatters - Ruff | ||
|
|
||
| To lint and format `Python` code files, it uses [Ruff][ruff], the default | ||
| configuration is set in the `pyproject.toml` file. | ||
|
|
||
| ```toml | ||
| select = [ | ||
| "B", # flake8-bugbear | ||
| "E", # pycodestyle | ||
| "F", # Pyflakes | ||
| "I", # isort | ||
| "PL", # pylint | ||
| "SIM", # flake8-simplify | ||
| "UP", # pyupgrade | ||
| ] | ||
| ``` | ||
|
|
||
| To configure it to your needs, refer to the [rules documentation][rudff-linter] | ||
| , and for formatter configuration, refer to the | ||
| [configuration documentation][ruff-formatter]. | ||
|
|
||
| ### Spell checker - Typos | ||
|
|
||
| If you want to ignore certain words, add them to the `pyproject.toml` file, | ||
| under the `tool.typos.default.extend-words` key. | ||
|
|
||
| ```toml | ||
| [tool.typos.default.extend-words] | ||
| mke = 'mke' | ||
| ``` | ||
|
|
||
| For further configuration, refer to the [typos docs][typos-docs]. | ||
|
|
||
| ### Static type checker - Mypy | ||
|
|
||
| Change the configuration in `pyproject.toml` file, for further information refer to | ||
| the [documentation][mypy-config]. | ||
|
|
||
| ### Documentation - Sphinx | ||
|
|
||
| Configuration for Sphinx is in the `docs/source/conf.py` file, for further info refer | ||
| to the [Sphinx documentation][sphinx-docs]. The default configuration uses | ||
| [furo theme][furo] and [ReadTheDocs][rtd] to host the documentation, you can | ||
| change the configuration using `/docs/source/conf.py` and `.readthedocs.yml` | ||
| file. | ||
|
|
||
| > **Note**: Make sure to setup the `ReadTheDocs` account and add the project to | ||
| the account to host the documentation. | ||
|
|
||
| ### Testing - pytest and pytest-cov | ||
|
|
||
| Generate a coverage report using `pytest-cov` and uploads it to codecov.io. | ||
|
|
||
| > **Note**: Make sure to setup the `Codecov` account and add the project to the | ||
| account to host the coverage report and add github [token](#cicd---github-actions). | ||
|
|
||
| ## CI/CD - GitHub Actions | ||
|
|
||
| Here are the GitHub Actions Secrets that need to be included in the repository | ||
| settings: | ||
|
|
||
| - `PYPI_PASSWORD`: PyPI account password. | ||
| - `CODECOV_TOKEN`: Codecov token. | ||
| - `AUTO_UPDATE_GITHUB_TOKEN`: GitHub token with permissions to write to the repository. | ||
|
|
||
| ## Disclaimer | ||
|
|
||
| Some of the links and images have been hardcoded with `ELIXIR Cloud & AAI`'s | ||
| assets in the documentation, please update them manually if needed. These | ||
| assets **MUST** be included for projects owned by ELIXIR Cloud & AAI, but | ||
| **MUST NOT** be included for projects that are not (personal projects, projects | ||
| owned by other orgs). | ||
|
|
||
| **Only`markdown` files and `images/` directory need to be changed.** | ||
|
|
||
| ## Contributing | ||
|
|
||
| This project is a community effort and lives off _your_ contributions, be it in | ||
| the form of bug reports, feature requests, discussions, fixes or any other form | ||
| of contribution! | ||
|
|
||
| Please refer to the guidelines available at [`CONTRIBUTING.md`][contributing] if | ||
| you are interested in contributing. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Please mind the code of conduct described in | ||
| [`CODE_OF_CONDUCT.md`][code-of-conduct] for all interactions with the community. | ||
| Please be nice to one another! :) | ||
|
|
||
| If you experience any unacceptable behavior by any member of the community, | ||
| please refer to the contact method specified in | ||
| [`CODE_OF_CONDUCT.md`][code-of-conduct] to report the incident to the community | ||
| leaders. | ||
|
|
||
| ## Versioning | ||
|
|
||
| The project adopts the [semantic versioning][semver] scheme for versioning. | ||
| Currently the service is in a pre-release stage, so changes to the API, | ||
| including breaking changes, may occur at any time without further notice. | ||
|
|
||
| ## License | ||
|
|
||
| This project is distributed under the [Apache License 2.0][badge-license-url], a | ||
| copy of which is also available in [`LICENSE`][license]. | ||
|
|
||
| ## Contact | ||
|
|
||
| The project is maintained by [ELIXIR Cloud & AAI][elixir-cloud-aai], a Driver | ||
| Project of the [Global Alliance for Genomics and Health (GA4GH)][ga4gh], under | ||
| the umbrella of the [ELIXIR][elixir] [Compute Platform][elixir-compute]. | ||
|
|
||
| To get in touch with us, please use one of the following routes: | ||
|
|
||
| - For filing bug reports, feature requests or other code-related issues, please | ||
| make use of the project's | ||
| [issue tracker](https://github.com/elixir-cloud-aai/cookiecutter-python/issues). | ||
| - For private/personal issues, more involved communication, or if you would like | ||
| to join our team as a regular contributor, you can either join our | ||
| [chat board][badge-chat-url] or [email] the community leaders. | ||
|
|
||
| [![logo-elixir]][elixir] [![logo-elixir-cloud-aai]][elixir-cloud-aai] | ||
|
|
||
| [badge-chat-url]: https://join.slack.com/t/elixir-cloud/shared_invite/enQtNzA3NTQ5Mzg2NjQ3LTZjZGI1OGQ5ZTRiOTRkY2ExMGUxNmQyODAxMDdjM2EyZDQ1YWM0ZGFjOTJhNzg5NjE0YmJiZTZhZDVhOWE4MWM | ||
| [badge-license-url]: http://www.apache.org/licenses/LICENSE-2.0 | ||
| [code-of-conduct]: CODE_OF_CONDUCT.md | ||
| [contributing]: https://elixir-cloud-aai.github.io/guides/guide-contributor/ | ||
| [elixir]: https://elixir-europe.org/ | ||
| [elixir-cloud-aai]: https://elixir-cloud.dcc.sib.swiss/ | ||
| [elixir-compute]: https://elixir-europe.org/platforms/compute | ||
| [email]: mailto:[email protected] | ||
| [ga4gh]: https://ga4gh.org/ | ||
| [license]: LICENSE | ||
| [logo-elixir]: images/logo-elixir.svg | ||
| [logo-elixir-cloud-aai]: images/logo-elixir-cloud-aai.svg | ||
| [poetry-org]: https://python-poetry.org/ | ||
| [poetry-docs]: https://python-poetry.org/docs/cli/ | ||
| [ruff]: https://docs.astral.sh/ruff | ||
| [ruff-linter]: https://docs.astral.sh/ruff/rules/ | ||
| [ruff-formatter]: https://docs.astral.sh/ruff/formatter | ||
| [typos-docs]: https://pypi.org/project/typos/ | ||
| [mypy-config]: https://mypy.readthedocs.io/en/stable/config_file.html | ||
| [sphinx-docs]: https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
| [furo]: https://pradyunsg.me/furo/quickstart/ | ||
| [rtd]: https://readthedocs.org/ | ||
| [semver]:https://semver.org/ |
Oops, something went wrong.