To use this, follow the instruction.
Then, add this package into
setup_requires parameter of your
setup(name='YourPackageName', version='1.2.3', ..., setup_requires=['github-distutils >= 0.1.0'])
Now there will be
github_upload command for your
$ python setup.py github_upload --help Common commands: (see '--help-commands' for more) ... Options for 'github_upload' command: --repository (-R) GitHub repository name e.g. user/reponame --username (-u) GitHub username --password (-p) GitHub password ...
--password are not present, it will
shows the prompt.
--repository is required.
Upload is very easy:
$ python setup.py sdist github_upload -R user/reponame register
- Makes the source distribution file. If your package name is
YourPackageNameand its version is
1.2.3, and then its file name becomes
github_upload -R user/reponame
- Uploads the built source distribution file into your GitHub repository. It does not mean that it will be version-controlled, but it will be simply uploaded to its downloads page.
- Using the GitHub download URL registers the package of this version into PyPI. The URL of PyPI page will be http://pypi.python.org/YourPackageName/1.2.3
You can make default values for these options by specifying in the
configuration file. For example, if you want to default
setup.cfg file like (hyphens becomes underscores):
[upload] repository = user/reponame
You can make a shorthand alias as well:
[aliases] release = sdist github_upload register
Author and license
It is distributed under Public Domain. Just do what you want to do with this. Written by Hong Minhee.
You can checkout the source code from its GitHub repository:
$ git clone git://github.com/dahlia/github-distutils.git
If you found a bug, please report it to the issue tracker.
For Bitbucket users
Use bitbucket-distutils which is a package by the same author if you are using Bitbucket instead of GitHub.
Released on June 20, 2012. Beta version.
- Allow upper cases for GitHub repository names. [#1 by Xavier Barbosa]
- Windows compatibility: fixed
Released on May 27, 2012. First alpha version.