Giter Site home page Giter Site logo

adamchainz / py-minimal-script Goto Github PK

View Code? Open in Web Editor NEW

This project forked from springerle/py-minimal-script

0.0 3.0 0.0 28 KB

:cookie: Minimalistic template for one-module Python scripts, but with full project automation

License: Creative Commons Zero v1.0 Universal

Python 100.00%

py-minimal-script's Introduction

py-minimal-script

A cookiecutter template that creates a minimalistic template for one-module Python scripts, but with full project automation via Invoke and setuptools.

LogoGroupsMIT+CC0 licensedTravis CIGitHub IssuesGitHub Release

Features

The resulting project uses rituals and invoke for task automation, and setuptools for building and distributing the script. A provided autoenv script takes care of creating a fully boot-strapped virtualenv – it can also be used manually if you don't want to install autoenv.

Documentation for the script can be provided via the README.rst of the project, which is also used for the PyPI entry. Having no full Sphinx documentation is a concious decision, use the py-generic-project template for more complex tools that aren't a good fit for this reduced project setup.

To distribute your tool as a Debian package, especially when it has outside dependencies (i.e. a non-empty requirements.txt), consider adding the dh-virtualenv template.

Split Licensing

Since the files contained in the {{cookiecutter.repo_name}} archetype itself will comprise the foundation of your project, they're unlicensed using the “Creative Commons Zero v1.0 Universal” license. All other files outside the {{cookiecutter.repo_name}} directory are MIT-licensed – this effectively means you only have to attribute this project if you re-use all or parts of the contained templating mechanics and documentation.

To make the confusion complete, the template as-is gives the created project an Apache 2.0 license by default – you have to change the LICENSE file, setup.py and the script module to change that, after you materialized the template.

  • Project License for the project.
  • Template License for the template proper (everything in {{cookiecutter.repo_name}}).

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.