Set up a minimal, yet comfortable structure for a Python project.
This repository has been archived on 2023-10-26. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
David Gay 44cb54b378
update before repo archive
2020-05-13 19:40:27 -04:00
bin Add the full list of classifiers 2013-03-13 22:29:08 -04:00
pythong Fix broken project creation and release 0.7.1 2014-03-09 12:47:06 -04:00
tests Fix prompt_optionlist test. 2013-03-27 19:27:56 -04:00
.gitignore Initial commit 2013-03-05 13:49:30 -08:00
CHANGELOG.md Fix broken project creation and release 0.7.1 2014-03-09 12:47:06 -04:00
MANIFEST.in Resolve the version importing problem. 2013-11-22 13:23:12 -05:00
README.rst update before repo archive 2020-05-13 19:40:27 -04:00
setup.py update before repo archive 2020-05-13 19:40:27 -04:00

README.rst

pythong
=======

:Author: David Gay <hello@davidgay.org>

Set up a minimal, yet comfortable structure for a Python project.

⚠️ This project is no longer maintained. As of 2020, it hasn't been updated
in six or seven years. Use at your own risk.

Features
--------

-   Create a standard Python project directory structure

-   Get help creating your setup.py file, or
    choose to write it yourself by passing the ``--snap``
    command

-   Clear your project of messy build files (build/dist/egg/pyc)
    with the ``--wash`` command

-   Generate a distribute_setup.py file to use a setup.py file
    with distribute

-   Use a tree-style menu to set your PyPI classifiers in your
    setup.py file


Example Usage
-------------

Create a new project like so::

    $ pythong mynewproject

Or, for a quicker setup... ::

    $ pythong --snap

Including the project name in the command is optional.

You can **wash** your pythong of messy build files::

    $ pythong --wash

Pythong will help you add classifiers to your setup.py
during project creation, or after the fact with the **label** command::

    $ pythong --label

Files and directories can be added to the manifest file with **pin**::

    $ pythong --pin [FILE_OR_DIRECTORY]

A full list of options can be seen with::

    $ pythong --help

Get Pythong
-----------

You can install the latest release of Pythong from `PyPI
<https://pypi.python.org/pypi/pythong>`_ with pip::

    $ pip install pythong

You can also get the source from PyPI or `GitHub
<https://github.com/oddshocks/pythong>`_.
Contributions are welcome! Yay, software freedom!

License
-------

pythong is released under the GNU GPLv3+.

Contributors
------------

Feel free to add your name.

-   David Gay  <hello@davidgay.org>
-   Ryan Scott Brown  <ryansb@csh.rit.edu>
-   Ralph Bean  <rbean@redhat.com>