Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

A new Python project

Project Description
# new-project

A new Python project.

[![Travis CI](https://api.travis-ci.org/sundeer/new-project.svg)](https://travis-ci.org/sundeer/new-project)
 [![Coveralls](https://img.shields.io/coveralls/sundeer/new-project.svg)](https://coveralls.io/r/sundeer/new-project)
[![GitHub Issues](https://img.shields.io/github/issues/sundeer/new-project.svg)](https://github.com/sundeer/new-project/issues)
 [![License](https://img.shields.io/pypi/l/new-project.svg)](https://github.com/sundeer/new-project/blob/master/LICENSE)
 [![Development Status](https://pypip.in/status/new-project/badge.svg)](https://pypi.python.org/pypi/new-project/)
 [![Latest Version](https://img.shields.io/pypi/v/new-project.svg)](https://pypi.python.org/pypi/new-project/)
 [![Download format](https://pypip.in/format/new-project/badge.svg)](https://pypi.python.org/pypi/new-project/)
 [![Downloads](https://img.shields.io/pypi/dw/new-project.svg)](https://pypi.python.org/pypi/new-project/)


## Overview




## Installation

*New Project* can be installed via ``pip install new-project`` as usual,
see [releases](https://github.com/sundeer/new-project/releases) for an overview of available versions.
To get a bleeding-edge version from source, use these commands:

```sh
repo="sundeer/new-project"
pip install -r "https://raw.githubusercontent.com/$repo/master/requirements.txt"
pip install -UI -e "git+https://github.com/$repo.git#egg=${repo#*/}"
```

See [Contributing](#contributing) on how to create a full development environment.

To add bash completion, read the [Click docs](http://click.pocoo.org/4/bashcomplete/#activation) about it,
or just follow these instructions:

```sh
cmdname=new-project
mkdir -p ~/.bash_completion.d
( export _$(tr a-z- A-Z_ <<<"$cmdname")_COMPLETE=source ; \
$cmdname >~/.bash_completion.d/$cmdname.sh )
grep /.bash_completion.d/$cmdname.sh ~/.bash_completion >/dev/null \
|| echo >>~/.bash_completion ". ~/.bash_completion.d/$cmdname.sh"
. "/etc/bash_completion"
```


## Usage




## Contributing

Contributing to this project is easy, and reporting an issue or
adding to the documentation also improves things for every user.
You don’t need to be a developer to contribute.
See [CONTRIBUTING](https://github.com/sundeer/new-project/blob/master/CONTRIBUTING.md) for more.

As a documentation author or developer,
to **create a working directory** for this project,
call these commands:

```sh
git clone "https://github.com/sundeer/new-project.git"
cd "new-project"
. .env --yes --develop
invoke build --docs test check
```

You might also need to follow some
[setup procedures](https://py-generic-project.readthedocs.org/en/latest/installing.html#quick-setup)
to make the necessary basic commands available on *Linux*, *Mac OS X*, and *Windows*.

**Running the test suite** can be done several ways, just call ``invoke test`` for a quick check,
or ``invoke test.tox`` for testing with all supported Python versions
(if you [have them available](https://github.com/jhermann/priscilla/tree/master/pyenv)).
Use ``invoke check`` to **run a code-quality scan**.

To **start a watchdog that auto-rebuilds documentation** and reloads the opened browser tab on any change,
call ``invoke docs -w -b`` (stop the watchdog using the ``-k`` option).


## References

**Tools**

* [Cookiecutter](http://cookiecutter.readthedocs.org/en/latest/)
* [PyInvoke](http://www.pyinvoke.org/)
* [pytest](http://pytest.org/latest/contents.html)
* [tox](https://tox.readthedocs.org/en/latest/)
* [Pylint](http://docs.pylint.org/)
* [twine](https://github.com/pypa/twine#twine)
* [bpython](http://docs.bpython-interpreter.org/)
* [yolk3k](https://github.com/myint/yolk#yolk)

**Packages**

* [Rituals](https://jhermann.github.io/rituals)
* [Click](http://click.pocoo.org/)


## Acknowledgements

Release History

Release History

This version
History Node

0.4.9

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
new_project-0.4.9.zip (23.4 kB) Copy SHA256 Checksum SHA256 Source Jul 21, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting