Skip to main content

Creates a new python package from basic template

Project description

Pypkg Generator

Create a simple template of a python package.

Create a basic template of python package with a simple command line tool.

Installation

OS X & Linux:

From PYPI

$ pip3 install pypkg-generator

from the source

$ git clone https://github.com/dany2691/pypkg-generator.git
$ cd pypkg-generator
$ python3 setup.py install

Usage example

Open a terminal and type:

$ pkg-generator --help

And it'll display:

Options:
  -n, --name TEXT       The name of the package
  -p, --path TEXT       The path where the package will be created
  --tests / --no-tests  Create test suite directory or not, created by default
  --help                Show this message and exit.

There are many options for customization, you can decide what file will be created or not.

You must assign a name, or the project will be name forgotten_name.

$ pkg-generator --name my-awesome-project

You can explicitly pass a path, otherwise, the project will be created in the current directory.

$ pkg-generator --name my-awesome-project --path /home/user/Documents/

Development setup

This project uses pipenv for dependecy resolution. It's a kind of mix between pip and virtualenv. Follow the next instructions to setup the development enviroment.

$ git clone https://github.com/dany2691/pypkg-generator.git
$ cd pypkg-generator
$ pipenv shell
$ pip3 install -e .

To run the test-suite, inside the pypkg-generator directory:

$ pytest -vv test/

Meta

Daniel Omar Vergara Pérez – @dan1_netdaniel.omar.vergara@gmail.com

https://github.com/dany2691

Contributing

  1. Fork it (https://gitlab.com/hexagondata_projects/pypkg-generator)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypkg-generator-0.4.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

pypkg_generator-0.4.1-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file pypkg-generator-0.4.1.tar.gz.

File metadata

  • Download URL: pypkg-generator-0.4.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.7.1

File hashes

Hashes for pypkg-generator-0.4.1.tar.gz
Algorithm Hash digest
SHA256 fb536fcbb3b6ab4bf4de47c92466a5bc2c72865399526b1e3b0cefebe78e474c
MD5 428678e12fe80079af1257759ec35829
BLAKE2b-256 cf055336c4814347ed0dc09210891ab41b1ea830043a6f4fbf7468efe861b671

See more details on using hashes here.

File details

Details for the file pypkg_generator-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: pypkg_generator-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.7.1

File hashes

Hashes for pypkg_generator-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5cb85d4c40af71c30a6b9ec5cb10e5b8aaf6fab9905b0a59bd490245ff1ed7d2
MD5 d197a094c74d9c8fdd1d5a5ff2b27f5c
BLAKE2b-256 77415949877e5f399671e64c6f0a84ca05f114706220e848bfc4b8cb70ece88b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page