Creates a new python package from basic template
Project description
# Pypkg Generator
> Create a simple template of a python package.
[![PyPI version](https://badge.fury.io/py/pypkg-generator.svg)](https://badge.fury.io/py/pypkg-generator)
Create a basic template of python package with a simple command line tool.
## Installation
OS X & Linux:
From PYPI
```sh
$ pip3 install pypkg-generator
```
from the source
```sh
$ git clone https://github.com/dany2691/pypkg-generator.git
$ cd pypkg-generator
$ python3 setup.py install
```
## Usage example
Open a terminal and type:
```sh
$ pkg-generator --help
```
And it'll display:
```sh
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*.
```sh
$ pkg-generator --name my-awesome-project
```
You can explicitly pass a path, otherwise, the project will be created in the current directory.
```sh
$ 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.
```sh
$ 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:
```shell
$ pytest -vv test/
```
## Meta
Daniel Omar Vergara Pérez – [@dan1_net](https://twitter.com/dan1_net) – daniel.omar.vergara@gmail.com
[https://github.com/dany2691](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
> Create a simple template of a python package.
[![PyPI version](https://badge.fury.io/py/pypkg-generator.svg)](https://badge.fury.io/py/pypkg-generator)
Create a basic template of python package with a simple command line tool.
## Installation
OS X & Linux:
From PYPI
```sh
$ pip3 install pypkg-generator
```
from the source
```sh
$ git clone https://github.com/dany2691/pypkg-generator.git
$ cd pypkg-generator
$ python3 setup.py install
```
## Usage example
Open a terminal and type:
```sh
$ pkg-generator --help
```
And it'll display:
```sh
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*.
```sh
$ pkg-generator --name my-awesome-project
```
You can explicitly pass a path, otherwise, the project will be created in the current directory.
```sh
$ 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.
```sh
$ 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:
```shell
$ pytest -vv test/
```
## Meta
Daniel Omar Vergara Pérez – [@dan1_net](https://twitter.com/dan1_net) – daniel.omar.vergara@gmail.com
[https://github.com/dany2691](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.2.tar.gz
(4.3 kB
view hashes)
Built Distribution
Close
Hashes for pypkg_generator-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 407ec1a1ea20ae454016355c06b87373865b2ff2411b1e50367ffeaaa6034c93 |
|
MD5 | 1e7bffdd9c363d18fd28e935911c1df7 |
|
BLAKE2b-256 | 61f57357f9f17f7f77c85e5a5f8f0651c563e3742d8200f75c8634fb61d4bdb3 |