<commit_before>Development
===========

Introduction
------------
This project uses a combination of virtualenv and zc.buildout to setup a self
contained development environment. It's designed so I can basically go to any
of my computers, clone the upstream repository, source the bootstrap script,
and begin working.

Also, git-flow is being used to manage the general workflow of the repository,
so please install it and stick with it.


Bootstrapping
-------------
With virtualenv and zc.buildout:
% source bootstrap
% buildout

With zc.buildout only:
% python bootstrap.py -d
% bin/buildout


Web Resources
-------------
Project website, bug database, and GIT repository is at:
http://github.com/mvillalba/python-namecheap

Project documentation (Sphinx) is at:
NOT-HOSTED-ANYWHERE-YET


Release Checklist
-----------------
 * Clone upstream to clean directory
 * Bootstrap environment
 * Start release branch (git-flow)
 * Run pylint
 * Run importchecker
   % importchecker src
 * Run pep8
   % pep8 -r src --count --statistics
 * Set/check version number (setup.py, project's __init__.py, docs)
 * Run test suite and check test coverage
   % nosetests --with-coverage --cover-inclusive --cover-erase
 * Freeze dependencies' version numbers in buildout.cfg and setup.py
 * Check bug database for open issues/bugs
 * Build documentation
 * Check documentation (coverage, grammar, contents, etc)
 * Update CHANGES
 * Update copyright statements if new year
 * Update setup.py
 * Create distribution bundles
   % buildout setup . sdist bdist bdist_egg
 * Check dist/* files (no plain text root passwords, all files present, do
   they work in a separate virtualenv with pip? do tests still pass?)
 * Upload to PyPI<commit_msg>Add backup repository URL (#3)<commit_after>Development
===========

Introduction
------------
This project uses a combination of virtualenv and zc.buildout to setup a self
contained development environment. It's designed so I can basically go to any
of my computers, clone the upstream repository, source the bootstrap script,
and begin working.

Also, git-flow is being used to manage the general workflow of the repository,
so please install it and stick with it.


Bootstrapping
-------------
With virtualenv and zc.buildout:
% source bootstrap
% buildout

With zc.buildout only:
% python bootstrap.py -d
% bin/buildout


Web Resources
-------------
Project website, bug database, and GIT repository is at:
http://github.com/mvillalba/python-namecheap

Project documentation (Sphinx) is at:
NOT-HOSTED-ANYWHERE-YET

Backup GIT repository:
https://gitorious.org/python-namecheap/python-namecheap


Release Checklist
-----------------
 * Clone upstream to clean directory
 * Bootstrap environment
 * Start release branch (git-flow)
 * Run pylint
 * Run importchecker
   % importchecker src
 * Run pep8
   % pep8 -r src --count --statistics
 * Set/check version number (setup.py, project's __init__.py, docs)
 * Run test suite and check test coverage
   % nosetests --with-coverage --cover-inclusive --cover-erase
 * Freeze dependencies' version numbers in buildout.cfg and setup.py
 * Check bug database for open issues/bugs
 * Build documentation
 * Check documentation (coverage, grammar, contents, etc)
 * Update CHANGES
 * Update copyright statements if new year
 * Update setup.py
 * Create distribution bundles
   % buildout setup . sdist bdist bdist_egg
 * Check dist/* files (no plain text root passwords, all files present, do
   they work in a separate virtualenv with pip? do tests still pass?)
 * Upload to PyPI
{'fraction_non_alphanumeric': 0.10075992119335772, 'fraction_numerical': 0.0014072614691809737, 'mean_word_length': 3.5976714100905562, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1810293', 'n_tokens_mistral': 993, 'n_tokens_neox': 941, 'n_words': 419}