Giter VIP home page Giter VIP logo

python-poetry-template's Introduction

Python + Poetry project template

What's inside

A ready to go project structure with

Getting started

Minimum steps for running the application

Depending on your setup, some steps might not be necessary

  • Set python version to be used for the project with poetry env use [path/to/python/executable]
    • NOTE: python version must be 3.12 or above
  • Install virtual environment and project dependencies with poetry install
  • Start the application through a pre-defined poetry script with poetry run start.

Additional steps to get ready for development

Depending on your setup, some steps might not be necessary

  • Initialize git repository with git init
  • Add dependencies with poetry add [depencency-name]
  • Add dependencies to a specified group (e.g. dev dependencies) with poetry add --group [group-name] [depencency-name]
  • Configure pre-commit hooks with poetry run pre-commit install
  • Run pre-commit hooks once on all files with poetry run pre-commit run --all-files
  • Run tests with poetry run pytest

python-poetry-template's People

Contributors

dmitriysevkovych avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.