Skip to main content

Opinionated 2020 Python template and metadata synchronizer.

Project description

Tyrannosaurus Reqs

Build status Latest version on PyPi Supported Python versions Documentation status Build & test Travis License

An opinionated 2020 Python template.

I wrote this after making nearly 50 commits to configure readthedocs, PyPi, Tox, Docker, Travis, and Github actions. This avoids that struggle for 99% of projects. Just clone and modify or use tyrannosaurus new. Install with pip install tyrannosaurus.

  • When you commit, your code will be linted.
  • When you push or make a pull request, your code will be built and tested. Metadata will be synced, security checks will be run, style will be checked, documentation will be generated, and docker images, sdists, and wheels will be built.
  • When you release on Github, your code will be published on PyPi. Just add PYPI_TOKEN as a Github repo secret.

⚠ Status: Under development. The template works great. Commands mostly work, but sync does little.

Also comes with nice Github labels, a changelog template, Conda recipe generation, and various other integrations. Tyrannosaurus itself is included as a dependency to copy metadata between config files, such as the project version, description, copyright, and build and doc requirements.

To run locally, install Poetry and Tox (pip install tox). Then just type tox to build artifacts and run tests.

For more information, see the docs.

To make a new project, run:

pip install tyrannosaurus
tyrannosaurus new projectname --license apache

Building, extending, and contributing

New issues and pull requests are welcome. Tyrannosaurus is licensed under the Apache License, version 2.0.

                                              .++++++++++++.
                                           .++HHHHHHH^^HHH+.
                                          .HHHHHHHHHH++-+-++.
                                         .HHHHHHHHHHH:t~~~~~
                                        .+HHHHHHHHHHjjjjjjjj.
                                       .+NNNNNNNNN/++/:--..
                              ........+NNNNNNNNNN.
                          .++++BBBBBBBBBBBBBBB.
 .tttttttt:..           .++BBBBBBBBBBBBBBBBBBB.
+tt+.      ``         .+BBBBBBBBBBBBBBBBBBBBB+++cccc.
ttt.               .-++BBBBBBBBBBBBBBBBBBBBBB++.ccc.
+ttt++++:::::++++++BBBBBBBBBBBBBBBBBBBBBBB+..++.
.+TTTTTTTTTTTTTBBBBBBBBBBBBBBBBBBBBBBBBB+.    .ccc.
  .++TTTTTTTTTTBBBBBBBBBBBBBBBBBBBBBBBB+.      .cc.
    ..:++++++++++++++++++BBBBBB++++BBBB.
           .......      -LLLLL+. -LLLLL.
                        -LLLL+.   -LLLL+.
                        +LLL+       +LLL+
                        +LL+         +ff+
                        +ff++         +++:
                        ++++:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tyrannosaurus-0.2.0.tar.gz (16.5 kB view hashes)

Uploaded Source

Built Distribution

tyrannosaurus-0.2.0-py3-none-any.whl (23.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page