Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.
/ YeomanPywork Public archive

🐍Pywork is a Yeoman generator to scaffold a Bare-bone Python Application

Notifications You must be signed in to change notification settings

vutran1710/YeomanPywork

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pywork


python app yeoman generator
Yeoman | Npm Pywork | Home


PyWork is a Yeoman generator for a basic python-worker project that makes use of Pipenv, Logzero and Pydantic.

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:

and more to come...

Some extra useful stuffs provided are:

  • Docker:
    • Dockerfile
    • .dockerignore

Get set

Have Yeoman installed globally.

$ npm install -g yo

If you haven't used Yeoman before, take a look at the Yeoman's Official Website for details.

Prepare project with Yeoman

  • Install generator-pywork
$ npm install -g generator-pywork
  • Init a project, w/o git
$ 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.

About

🐍Pywork is a Yeoman generator to scaffold a Bare-bone Python Application

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published