Git Product home page Git Product logo

bank-ledger's Introduction

Modern python app boilerplate

Included in this boilerplate:

  • pyenv for python version management
  • poetry for dependency management integrated with pyenv
  • pre-commit for linting and formatting
  • pytest for testing
  • black for formatting
  • flake8 for linting
  • isort for sorting imports
  • mypy for static type checking
  • virtualenv created by poetry resides in .venv folder

How to start

  1. Make sure you have python required interpreter installed in pyenv e.g.
  2. Rename project:
  • Rename app folder to your app name if needed (mv bank_ledger new_bank_ledger) and then:

    find ./ -type f -not -path "./.git/*" -exec sed -i 's/bank_ledger/new_bank_ledger/g' {} \;
    find ./ -type f -not -path "./.git/*" -exec sed -i 's/bank_ledger/new-bank_ledger/g' {} \;
    
  • or use make rename-project NEW_APP_NAME=new_bank_ledger to do it for you

  1. make install
  2. make test
  3. Make sure it's working: poetry run app-cli "Developer"
  4. Optionally, squeeze history into one commit: git reset $(git commit-tree HEAD^{tree} -m "Initial commit")

Other useful commands

  • Check current poetry virtualenv and change it
   $ poetry env info
   $ poetry env list
   $ poetry env remove /home/PATH/bin/python
   $ make install
  • Cherry-pick commit from repository cloned from this one:
   $ git remote add projectB /home/you/projectB
   $ git fetch projectB
   $ git cherry-pick <commit from projectB repo>

bank-ledger's People

Contributors

b1r3k 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.