Reference of files

This section explains what the files are and why they exist.

Files that Tyrannosaurus created

Some of these can be deleted if you are not using those tools.

filename	purpose
.dockerignore	Tells Docker to ignore temp paths
.editorconfig	Tells IDEs how to handle indentation for different file types
.gitignore	Avoids committing temp, build, and other unwanted files
.pre-commit-config.yaml	Forces checks that prevent unnecessary fixup commits
.travis.yml	Remove, assuming you are not using Travis
.scrutinizer.yml	Configuration for scrutinizer build, coverage, and/or code quality analysis
azure-pipelines.yml	Remove, assuming you are not using Azure Pipelines
CHANGELOG.md	Always keep a changelog.
CITATION.cff	Recommends citations (obscure)
codemeta.json	Documents scientific software (obscure)
CONTRIBUTING.md	Policy on how to contribute (recognized by GitHub)
Dockerfile	Tells Docker how to build the code
Vagrantfile	Vagrantfile for consistent dev environments
LICENSE.txt	License file as plain text (recognized by GitHub)
poetry.lock	Generated by Poetry for consistent and fast dependency resolution
pyproject.toml	Core metadata and config file used by a large number of tools
README.md	Obviously needed (recognized by GitHub)
readthedocs.yml	Tells readthedocs how to build the documentation
SECURITY.md	Security policy document. (recognized by GitHub)
tox.ini	Pipeline file for Tox to build and test the code
.github/ISSUE_TEMPLATE	Tells GitHub to suggest templates for new issues
.github/workflows/checklinks.yml	GitHub project settings via Probot
.github/workflows/codeql.yml	Workflow for GitHub CodeQL action
.github/workflows/commit.yml	Builds, tests, and updates code quality reports on pushing to main
.github/workflows/labels.yml	Sets GitHub issue labels specified in .github/labels.json on push
.github/workflows/publish.yml	Publishes when a GitHub release is made (does not test)
.github/workflows/pull.yml	Tests, but does not update reports, on pull request to main
.github/workflows/settings.yml	GitHub project settings via Probot
dependabot.yml	Tells dependabot to run weekly
labels.json	Specifies the GitHub issue labels to create or update
PULL_REQUEST_TEMPLATE.md	Requests a reference to an issue for pull requests (used by GitHub)
docs/conf.py	Configuration file for building documentation with Sphinx
docs/index.rst	reStructuredText documentation main page
docs/requirements.txt	Dependencies required by readthedocs
recipes/*/meta.yaml	A Conda-Forge recipe that tyrannosaurus recipe can generate
environment.yml	A Conda environment file that tyrannosaurus env can generate
tests/__init__.py	Utilities for tests
tests/resources/	Resource files that tests need
tests/**/test_*.py	Test source files
{pkg}/__init__.py	Declares dunder metadata and provides project utilities
{pkg}/resources/	Resource files that the main code needs
{pkg}/cli.py	Command-line interface with Typer
{pkg}/**/*.py	Main code files!

Temporary files

These are temporary files, which you can delete.

filename	purpose
.tox/	Cache from Tox containing virtual environments (avoid deleting)
docs/autoapi/	Generated reStructuredText files from code docstrings (can delete)
docs/html/	Generated HTML files for all documentation (can delete)
dist/	Poetry-generated sdists and wheels files (can delete)
.tyrannosaurus/	Temporary backup and trashed files from Tyrannosaurus (can delete)
.coverage	Generated coverage reports (can delete)
eggs/	Obsolete generated egg files (auto-deleted)
{pkg}.egg-info	Obsolete generated egg files (auto-deleted)
**/.pytest_cache/	Cache files from pytest (auto-deleted)

Non-included files

These may be useful for some projects, or are alternatives to those used.

filename

purpose

AUTHORS.md Perfectly fine to include if there are many authors (duplicates info) BACKERS.md Perfectly fine to include CODE_OF_CONDUCT.md Perfectly fine to include codecov.yml May be useful to include when using codecov HISTORY.md Perfectly valid, but CHANGELOG.md seems more clear Makefile Could be used to automate additional development tasks

Bad/obsolete files

These are files that you specifically should not use.

filename	purpose
dev-requirements.txt	Obsolete, and has serious problems
LICENSE	No-extension filenames cause problems for Windows
MANIFEST.in	Obsolete
setup.cfg	Obsolete
setup.py	Obsolete with Poetry, and has serious problems
requirements.txt	Obsolete, and has serious problems
test-requirements.txt	Obsolete, and has serious problems