Welcome to github_cloner’s documentation!

Contents:

github_cloner

Documentation Status

Python Boilerplate contains all the boilerplate you need to create a Python package.

Features

  • TODO

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install github_cloner, run this command in your terminal:

$ pip install statsbiblioteket.github_cloner

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for github_cloner can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/statsbiblioteket/github_cloner

Or download the tarball:

$ curl  -OL https://github.com/statsbiblioteket/github_cloner/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use github_cloner as a library in a project:

import statsbiblioteket.github_cloner

Github Cloner command

Clones github repositories and github gists

usage: github_cloner [-h] [--org ORGS] [--user USERS] [--logLevel LOGLEVEL]
                     [--logFile LOGFILE]
Options:
--org The github organisation to backup
--user The github user to backup
--logLevel=DEBUG
 the log level
--logFile=log.log
 the log file

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/statsbiblioteket/github_cloner/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

github_cloner could always use more documentation, whether as part of the official github_cloner docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/statsbiblioteket/github_cloner/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up github_cloner for local development.

  1. Fork the github_cloner repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/github_cloner.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv github_cloner
$ cd github_cloner/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 github_cloner tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/blekinge/github_cloner/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_github_cloner

Credits

Based on the work of Marius Gedminas (https://github.com/mgedmin) <marius@gedmin.as>, which can be found at https://gist.github.com/4319265

Development Lead

Contributors

None yet. Why not be the first?

History

0.2.1 (2016-08-02)

  • Fixed bugs

0.1.0 (2016-06-21)

  • First Beta release on PyPI.

Indices and tables