GithubHelp home page GithubHelp logo

incipyt's Introduction

incipyt

It begins...

incipyt [ˈɪŋkɪpɪt̪] is a command-line tool that bootstraps a Python project.

$ pip install incipyt

Usage

incipyt is not opinated, by default it setups the tools recommanded in the PyPA/packaging-projects tutorial: pyproject.toml and setuptools in addition to git and sphinx which are de-facto standard.

$ python -m incipyt mynewproject
Project Name [mynewproject]:
Author [John Doe]:
Author email [[email protected]]: [email protected]
$ tree mynewproject
mynewproject/
├── .git/
├── docs/
│   ├── _build/
│   ├── _static/
│   ├── _templates/
│   ├── conf.py
│   ├── index.rst
│   ├── make.bat
│   └── Makefile
├── mynewproject/
│   └── __init__.py
├── tests/
├── .gitignore
├── LICENSE
├── pyproject.toml
├── README.md
├── setup.cfg
└── setup.py

incipyt provides a rich command line interface so you can choose various build systems, version control system, virtual environments, documentation software, linters, formatters, etc.

$ python -m incipyt --help

Contribute

incipyt is released under the MIT license and is open to contributions

The complete setup instruction are found on the dev-instructions. Below is the minimum to get started:

$ git clone https://github.com/NotANameServer/incipyt
$ cd incipyt
$ git config commit.template .gitmessage
$ python -m venv --upgrade-deps .env
$ source .env/bin/activate
$ python -m pip install --upgrade flit
$ python -m flit install --pth-file --deps develop
$ python -m pytest -vv tests
$ pre-commit & pre-commit install

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.