This project has been archived by its maintainers, and is no longer receiving any updates.
zygoat
What is zygoat?
zygoat is a command line tool used to bootstrap and configure a React/Django/Postgres stack web application.
Linting, test configuration, boilerplate, and development environment are automatically taken care of using zygoat so that you can get up and running faster.
zygoat also includes a preset deployment configuration to allow you to deploy your stack to an AWS environment with a single command. You'll get a full serverless AWS stack to keep things inexpensive and nimble.
How does it work?
zygoat works by defining Components, defined as parts of projects, and then defining how you implement those components based on whether you're creating a new project, updating an existing project, or deleting a component that's no longer needed.
For instance, for the python backend, we want to include black, which is a tool for automatically formatting python code in a standard way to make it pep8 compliant. To install black in for the python backend part of the project, we create a Component for it, specifically a FileComponent, which defines how we treat files that we need in projects. Then we register the Black component (defined in black.py) with the Backend component (defined in backend/__init__.py) as a sub component. This way, whenever you create or update (or delete) a project with the Backend component, you'll do the same 'phase' to the Black component.
Installation
pip install --upgrade zygoat
Usage
mkdir my-cool-new-app && cd my-cool-new-app
git init
zg new my-cool-new-app
For more customization and configuration, check out the official documentation.
How do I develop changes for it?
Make a new git repository somewhere, we'll call it test-zg
mkdir test-zg && cd test-zg
git init
Install the zygoat package locally
pip install --user --upgrade ~/Projects/zygoat # Or wherever you have it
If you're using the asdf version manager, reshim
asdf reshim python
Run zg commands, see if they fail
zg new test
zg update
zg delete
Contributing
zygoat is developed using the Poetry packaging framework for Python projects to make development as simple and portable as possible.
Documentation
Metadata
Release files for zygoat 1.20.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| zygoat-1.20.0.tar.gz | 29.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| zygoat-1.20.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 83.2 kB
Release files / zygoat-1.20.0.tar.gz
| Download URL | zygoat-1.20.0.tar.gz |
|---|---|
| Size | 29.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
256cb8e136dbaf2cc40a5ddc985de760af3e9a741a703ee1aacde083c7a89aa8
|
|
BLAKE2b-256 checksum How to use checksums |
9b521dcc91139d4c58446c08908b473b7da5f6f364f3829e4c9b24c1a3daf8f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.7.17 Linux/6.2.0-1016-azure
|
Release files / zygoat-1.20.0-py3-none-any.whl
| Download URL | zygoat-1.20.0-py3-none-any.whl |
|---|---|
| Size | 53.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8cc810ab3d7ce4c9b9669b5116ab389641f7fac6b87fffef013c3f4e77d3e010
|
|
BLAKE2b-256 checksum How to use checksums |
abd159dfbbe2968793d9fcf53b7f78e5c6b2b7e1e76d43139db46089b90ede2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.7.17 Linux/6.2.0-1016-azure
|
Security for zygoat 1.20.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.