Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vutran1710/YeomanPywork
🐍Pywork is a Yeoman generator to scaffold a Bare-bone Python Application
https://github.com/vutran1710/YeomanPywork
fastapi generator logzero pipenv pydantic python scaffolding yeoman
Last synced: 13 days ago
JSON representation
🐍Pywork is a Yeoman generator to scaffold a Bare-bone Python Application
- Host: GitHub
- URL: https://github.com/vutran1710/YeomanPywork
- Owner: vutran1710
- Archived: true
- Created: 2019-12-11T04:52:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T08:58:55.000Z (over 1 year ago)
- Last Synced: 2024-08-09T21:45:08.611Z (3 months ago)
- Topics: fastapi, generator, logzero, pipenv, pydantic, python, scaffolding, yeoman
- Language: Python
- Homepage:
- Size: 466 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-fastapi - Pywork - [Yeoman](https://yeoman.io/) generator to scaffold a FastAPI app. (Projects / Boilerplate)
- awesome-fastapi - Pywork - [Yeoman](https://yeoman.io/) generator to scaffold a FastAPI app. (Projects / Boilerplate)
README
Pywork
python app yeoman generator
Yeoman |
Npm Pywork |
Home
`PyWork` is a [Yeoman](http://yeoman.io) generator for a basic python-worker project that makes use of
[Pipenv](https://pipenv.kennethreitz.org/en/latest/), [Logzero](https://logzero.readthedocs.io/en/latest/) and
[Pydantic](https://pydantic-docs.helpmanual.io/).
It includes a bunch of helpful dev-dependencies, being:
- jedi
- flake8
- pylint
- yapf
- pytest
...and few boilerplates for working with different databases/message broker using python clients like
- Redis
- AioRedis
- RabbitMQ
- Cassandra
- MySQL
- PostgreSQL
It supports framework-based application templates for frameworks like:
- [FastApi](https://fastapi.tiangolo.com/)
and more to come...
Some extra useful stuffs provided are:
- Docker:
+ `Dockerfile`
+ `.dockerignore`
## Get set
### Have `Yeoman` installed globally.
``` shell
$ npm install -g yo
```
If you haven't used `Yeoman` before, take a look at the [Yeoman's Official Website](http://yeoman.io) for details.
### Prepare project with Yeoman
- Install `generator-pywork`
``` shell
$ npm install -g generator-pywork
```
- Init a project, w/o `git`
``` shell
$ mkdir my-project && cd my-project
$ yo pywork
```
- Answer setup questions
+ **Project name** :: which is required
+ **Dependencies** :: some database clients you may wanna add, depending on your needs
With each selected database-client or third-party libraries, some extra application config variables may be added to
`config.ini`. So make sure to fix the `config.ini` after having finished installing all dependencies with `Pipenv`.
Formatting config can be changed by editting `setup.cfg`
### Start Coding
If everything else went well, you can start coding your project.