https://github.com/jacobsvante/pkgtmpl
Generate empty packages with sane defaults, for publishing to GitHub
https://github.com/jacobsvante/pkgtmpl
Last synced: about 1 year ago
JSON representation
Generate empty packages with sane defaults, for publishing to GitHub
- Host: GitHub
- URL: https://github.com/jacobsvante/pkgtmpl
- Owner: jacobsvante
- License: other
- Created: 2013-09-14T11:00:42.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-12-16T09:05:18.000Z (over 12 years ago)
- Last Synced: 2025-03-12T19:46:55.599Z (about 1 year ago)
- Language: Python
- Size: 184 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
**Author:** Jacob Magnusson. [Follow me on Twitter](twitter)
## About
Bootstrap python packages with sane defaults
Features include:
* Generates .gitignore, AUTHORS, CHANGELOG,
LICENSE (BSD simplified by default), MANIFEST.in, README.md,
requirements.txt, setup.py, tests.py and tox.ini.
* Sets your name, github username, package name in the templates by
reading a config that should be located @ ~/.config/pkgtmpl.ini.
* Optional: Add Travis CI status and twitter account to the readme
* Sets your name and year in the copyright notice of the license file
## Installation
$ pip install pkgtmpl
## Usage
Create `~/.config/pkgtmpl.ini` with your details. Example contents:
[general]
full_name = Jacob Magnusson
email = m@jacobian.se
github_username = jmagnusson
twitter = pyjacob
Basic usage example:
$ pkgtmpl mypackage ~/apps/mypackage
For more options:
$ pkgtmpl --help
## Python support
Python 2.7+ and Python 3.3+.
## Documentation
[docs]
[twitter]: https://twitter.com/pyjacob
[docs]: https://github.com/jmagnusson/pkgtmpl