A commandline interface for creating project structures
Project description
|PyPI version| |Build Status|
charmer
===========
A commandline interface for creating structured Python projects.
Installation
''''''''''''
::
pip install charmer
Usage
'''''
::
python -m charmer
If you trust ``charmer `` to make the right decisions, you can say 'yes' to all prompts:
::
python -m charmer -y
Detailed information
''''''''''''''''''''
Here is an example project structure created by this tool for a runnable project:
::
> proj_name
__init__.py
__main__.py
> tests
__init__.py
context.py
test_main.py
README.rst
setup.py
You can run your app as follows:
::
python -m proj_name
You can run tests as follows:
::
python -m unittest discover tests
You can also install your project in your own pip repository (or in a virtual environment) to make it runnable anywhere on your system:
::
pip install -e .
Note: the ``-e`` flag is optional. It will keep your pip repository synchronized with your source code.
Meta
''''
Ramon Hagenaars - ramon.hagenaars@gmail.com
This structure was inspired by `Kenneth Reitz <https://github.com/kennethreitz/samplemod>`_.
.. |PyPI version| image:: https://badge.fury.io/py/project-cli.svg
:target: https://badge.fury.io/py/project-cli
.. |Build Status| image:: https://travis-ci.org/ramonhagenaars/project-cli.svg?branch=master
:target: https://travis-ci.org/ramonhagenaars/project-cli
charmer
===========
A commandline interface for creating structured Python projects.
Installation
''''''''''''
::
pip install charmer
Usage
'''''
::
python -m charmer
If you trust ``charmer `` to make the right decisions, you can say 'yes' to all prompts:
::
python -m charmer -y
Detailed information
''''''''''''''''''''
Here is an example project structure created by this tool for a runnable project:
::
> proj_name
__init__.py
__main__.py
> tests
__init__.py
context.py
test_main.py
README.rst
setup.py
You can run your app as follows:
::
python -m proj_name
You can run tests as follows:
::
python -m unittest discover tests
You can also install your project in your own pip repository (or in a virtual environment) to make it runnable anywhere on your system:
::
pip install -e .
Note: the ``-e`` flag is optional. It will keep your pip repository synchronized with your source code.
Meta
''''
Ramon Hagenaars - ramon.hagenaars@gmail.com
This structure was inspired by `Kenneth Reitz <https://github.com/kennethreitz/samplemod>`_.
.. |PyPI version| image:: https://badge.fury.io/py/project-cli.svg
:target: https://badge.fury.io/py/project-cli
.. |Build Status| image:: https://travis-ci.org/ramonhagenaars/project-cli.svg?branch=master
:target: https://travis-ci.org/ramonhagenaars/project-cli
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
charmer-0.1.0.tar.gz
(6.3 kB
view hashes)