Skip to content

illud/pynavt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pynavt

  _____                         _   
 |  __ \                       | |  
 | |__) |   _ _ __   __ ___   _| |_ 
 |  ___/ | | | '_ \ / _` \ \ / / __|
 | |   | |_| | | | | (_| |\ V /| |_ 
 |_|    \__, |_| |_|\__,_| \_/  \__|
         __/ |                      
        |___/                       

Create project with Clean Architecture folder structure


Pynavt is a cli tool to create clean architecture app for you including Fastapi, bcrypt and jwt.

  • Creates Clean Architecture project for you

Features

Installation

Pynavt requires Python 3.6 to run.

Install the dependencies.

pip install pynavt

How to use

In your terminal type to see all avaible commands:

pynavt --help

To create a new Fastapi with clean architecture project(This includes a crud example with the name of Tasks):

pynavt --new yourProjectName

To create a new module with crud:

pynavt --module yourModuleName

To run the project:

uvicorn app:app --relaod

Database service

To create a new db service client with Mysql:

Mysql - to learn more visit (https://www.w3schools.com/python/python_mysql_getstarted.asp)

pynavt --client mysql

This will generate a database connection in infraestructure/databases/client.py

to use import the service in your repository.

Folder Structure:


|-- controller
|        |      
|        |-tasks --> This is and example folder(Create your own folder)
|            |       
|            |-tasks_controller.py --> This is and example controller file(Create your own controllers)
|            
|-- domain
|      |
|      |-useCase
|            |
|            |-tasks --> This is and example folder(Create your own folder)
|                | 
|                |-task_useCase.py --> This is and example useCase file(Create your own useCases)
|
|-- infraestructure
|           |
|           |-databases
|           |      |
|           |      |-client.py
|           |
|           |-entities
|           |      |
|           |      |-tasks --> This is and example folder(Create your own folder)
|           |          |
|           |          |-tasks_entity.py --> This is and example entity file(Create your own entity)
|           |
|           |-respository
|                  |
|                  |-tasks --> This is and example folder(Create your own folder)
|                      | 
|                      |-tasks_repository.py --> This is and example repository file(Create your own repositories)
|                       
|-- utils
        |
        |-errors
        |    |
        |    |-errros.py
        |
        |-services
                |
                |-jwt
                |   |
                |   |-jwt.py
                |
                |-bcrypt
                    |
                    |-bcrypt.py

License

MIT

Pynavt is MIT licensed."# Pynavt" "# pynavt" "# pynavt"

About

Pynavt is a cli tool to create clean architecture app for you including Fastapi, bcrypt and jwt.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages