github-tools - 源码 - 源码 - 免费下载

github-tools

文件大小： unknow

源码售价： 5 个金币积分规则积分充值

资源说明：Helpers for hosting python projects on GitHub

Github features Git repository hosting, a download page for your Git tags 
(or any archive), a basic issue tracker, a wiki and static page hosting 
(`gh-pages `_).

Github-tools defines a PasteScript template to create the basic layout,
some paver tasks (``github.tools.task.*``) to host your package documentation
on gh-pages and the pavement.py script to get started.


Requirements
============

This extension and its dependencies require:

 * a GitHub user account and,
 * Git (tested with 1.6.2.4),
 * GitPython 0.1.7
 * Python 2.5+.
 
It currently has only been tested on Ubuntu 8.04 (and Git built from source)
with Python 2.5 and Mac OS X 10.6 with python 2.6.

For Windows, It should work as long as 
`GitPython `_ does. However since it 
simply  start ``git`` subprocesses to work, it might be difficult to use with
Git installers like `msysgit `_ or 
`gitextensions `_. 


Installation
============

The easiest way to get github-tools is if you have setuptools / distribute installed::

	easy_install github-tools[template]

The current development version can be found at 
http://github.com/dinoboff/github-tools/tarball/master.


Usage
=====

Package layout
--------------

If you are starting from scratch, create the basic layout with paster::

	paster create -t gh_package 
	
The project name will be used for pypi and for your Github repository
(``http://github.com//``).

To finish your development environment setup, create a virtual environment
and deploy your package in development mode::

	cd 
	python bootstrap.py --no-site-packages
	
The basic package comes with a virtualenv boostrap script
to create an  isolated Python environments. To activate this environment
in your shell, run::

	source ./virtual-env/bin/activate
	# or .\virtual-env\Scripts\activate.bat on windows

Finally::

	paver generate_setup minilib develop

Paver add a ``setup.py`` file to your package and a portable paver library
(required by ``setup.py``), and deploy your application in development mode;
The "src" folder which contains your package is added to the Python path.

``setup.py`` does not contain much. All ``setup()`` parameters are set in 
``pavement.py``. All the distutils and setuptools task are available with paver 
and it is very easy to extends or add your own commands (see 
`paver documentation `_
for more details).  

You are ready to write your package and its documentation
(in ``docs/``). You should probably start tracking your project now::

	git init
	git add .
	git commit -m "initial import"  


Github project creation
-----------------------

When you are ready to share your work, you will need to 
create a repository at GitHub and push your local repository. Paver can do it 
for you. Paver will need your GitHub user name and token to create 
the repository. You can set them with the following command::

	git config --global github.user 
	git config --global github.token 
	
You can find your token on your 
`Github account page `_.

Then, to create the repository and upload your project::

	paver gh_register
	

Documentation hosting
---------------------
	
Once the project is created, you can create your gh-pages branch 
and upload it to GitHub::

	paver gh_pages_create gh_pages_build
	
Paver will create a submodule of your project at ``docs/_build/html``,
create a gh-pages root branch and push the branch to your project.
It then build the html doc. To clean the html build folder, it update 
the submodule (you will lose changes not committed and pushed), 
remove every files and directory (except ``.git/``) 
and rebuild the documentation.

When your documentation can be published, simply push your gh-pages submodule 
to GitHub::

	paver gh_pages_build gh_pages_update -m "update docs with..."
	
Your documentation should be available 
at ``http://.github.com/``.

You might also want to update the submodule reference (a submodule point 
to specific commit on a remote repository, not to the HEAD 
of a specific branch)::

	git add docs/_build/html
	git commit -m "update gh-pages submodule"
	
Help and development
====================

If you'd like to help out, you can fork the project
at http://github.com/dinoboff/github-tools/ and report any bugs 
at http://github.com/dinoboff/github-tools/issues.

部分文件列表（点击文件名可查看文件内容）

					
									本源码包内暂不包含可直接显示的源代码文件，请下载源码包。