TODO.md

This TODO list is automatically generated from the cookiecutter-python-project template. The following tasks need to be done to get a fully working project:

• Set up a remote repository. You can e.g. create a project in GitHub or GitLab and run the following commands in your locally generated project folder: git remote add origin <Remote-URL> For a seamless integration, the name of the project should also be your-project.
• Head to your user settings at https://pypi.org and setup PyPI trusted publishing. In order to do so, you have to head to the "Publishing" tab, scroll to the bottom and add a "new pending publisher". The relevant information is:
  • PyPI project name: your_project
  • Owner: None
  • Repository name: your-project
  • Workflow name: pypi.yml
  • Environment name: not required
• Enable the integration of Readthedocs with your Git hoster. In the case of Github, this means that you need to login at Read the Docs and click the button Import a Project.
• Enable the integration with codecov.io by heading to the Codecov.io Website, log in (e.g. with your Github credentials) and enable integration for your repository. In order to do so, you need to select it from the list of repositories (potentially re-syncing with GitHub). Then, head to the "Settings" Tab and select "Global Upload Token". Here, you should select the "not required" option.
• Adjust pyproject.toml to your needs, e.g., add description, e-mail, version number.
• Adjust CITATION.cff to your needs. See Citation File Format (CFF) Website for more information.