.. image:: https://github.com/ome/scc/workflows/Tox/badge.svg
:target: https://github.com/ome/scc/actions
.. image:: https://badge.fury.io/py/scc.svg
:target: https://badge.fury.io/py/scc
SCC
===
Introduction
------------
The scc command provides tools for simplifying the Git(Hub) workflow.
Documentation
-------------
Setup and usage instructions can be found on the `OME-contributing`_ pages.
Dependencies
------------
Direct dependencies of scc are:
- `PyGithub`_
Installation
------------
To install ``scc``, run::
$ python setup.py install
or using pip, run::
$ pip install scc
To upgrade your pip installation, run::
$ pip install -U scc
Usage
-----
The list of available commands can be listed with::
$ scc -h
For each subcommand, additional help can be queried, e.g.::
$ scc merge -h
Contributing
------------
PyGithub follows `PEP 8`_, the Style Guide for Python Code. Please check your
code with pep8_ or flake8_, the Python style guide checkers, by running
``flake8 -v .`` or ``pep8 -v .``.
.. _PEP 8: http://www.python.org/dev/peps/pep-0008/
Running tests
-------------
The tests are located under the `test` directory. To run all the tests, use
the `test` target of `setup.py`::
python setup.py test
Unit tests
^^^^^^^^^^
Unit tests are stored under the `test/unit` folder and can be run by calling::
python setup.py test -t test/unit
Unit tests are also run by the Travis_ build on every Pull Request opened
against the main repository.
Integration tests
^^^^^^^^^^^^^^^^^
Integration tests are stored under `test/integration`. Many integration tests
use snoopys-sandbox_ and snoopys-sandbox-2_ as sandbox repositories to test the
scc commands.
Running the integration test suite requires:
- a GitHub account
- a token-based GitHub connection, i.e. a ``github.token`` stored under
the local Git configuration file (a global token is ignored)::
$ git config github.token xxxx
- the user authenticated by the token defined above needs to own forks of
snoopys-sandbox_ and snoopys-sandbox-2_
Once this is set up, the integration tests can be run by calling::
python setupy.py test -s test/integration
License
-------
scc is released under the GPL.
Copyright
---------
2012-2019, The Open Microscopy Environment
.. _PyGithub: https://github.com/PyGithub/PyGithub
.. _pep8: https://pypi.python.org/pypi/pep8
.. _flake8: https://pypi.python.org/pypi/flake8
.. _snoopys-sandbox: https://github.com/ome/snoopys-sandbox
.. _snoopys-sandbox-2: https://github.com/ome/snoopys-sandbox-2
.. _Travis: https://travis-ci.org/ome/scc
.. _OME-contributing: https://ome-contributing.readthedocs.io/en/latest/scc.html
Raw data
{
"_id": null,
"home_page": "https://github.com/ome/scc",
"name": "scc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "",
"author": "The Open Microscopy Team",
"author_email": "ome-devel@lists.openmicroscopy.org.uk",
"download_url": "https://files.pythonhosted.org/packages/5b/ea/6a1e140b4a5a0eb40d45fcbdc5c8e88789b97e052b5c9baae8abcaa4f8bd/scc-0.19.1.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/ome/scc/workflows/Tox/badge.svg\n :target: https://github.com/ome/scc/actions\n\n.. image:: https://badge.fury.io/py/scc.svg\n :target: https://badge.fury.io/py/scc\n\nSCC\n===\n\nIntroduction\n------------\n\nThe scc command provides tools for simplifying the Git(Hub) workflow.\n\nDocumentation\n-------------\n\nSetup and usage instructions can be found on the `OME-contributing`_ pages.\n\nDependencies\n------------\n\nDirect dependencies of scc are:\n\n- `PyGithub`_\n\nInstallation\n------------\n\nTo install ``scc``, run::\n\n $ python setup.py install\n\nor using pip, run::\n\n $ pip install scc\n\nTo upgrade your pip installation, run::\n\n $ pip install -U scc\n\nUsage\n-----\n\nThe list of available commands can be listed with::\n\n $ scc -h\n\nFor each subcommand, additional help can be queried, e.g.::\n\n $ scc merge -h\n\nContributing\n------------\n\nPyGithub follows `PEP 8`_, the Style Guide for Python Code. Please check your\ncode with pep8_ or flake8_, the Python style guide checkers, by running\n``flake8 -v .`` or ``pep8 -v .``.\n\n.. _PEP 8: http://www.python.org/dev/peps/pep-0008/\n\n\nRunning tests\n-------------\n\nThe tests are located under the `test` directory. To run all the tests, use\nthe `test` target of `setup.py`::\n\n python setup.py test\n\nUnit tests\n^^^^^^^^^^\n\nUnit tests are stored under the `test/unit` folder and can be run by calling::\n\n python setup.py test -t test/unit\n\nUnit tests are also run by the Travis_ build on every Pull Request opened\nagainst the main repository.\n\nIntegration tests\n^^^^^^^^^^^^^^^^^\n\nIntegration tests are stored under `test/integration`. Many integration tests\nuse snoopys-sandbox_ and snoopys-sandbox-2_ as sandbox repositories to test the\nscc commands.\n\nRunning the integration test suite requires:\n\n- a GitHub account\n- a token-based GitHub connection, i.e. a ``github.token`` stored under\n the local Git configuration file (a global token is ignored)::\n\n $ git config github.token xxxx\n\n- the user authenticated by the token defined above needs to own forks of\n snoopys-sandbox_ and snoopys-sandbox-2_\n\nOnce this is set up, the integration tests can be run by calling::\n\n python setupy.py test -s test/integration\n\n\nLicense\n-------\n\nscc is released under the GPL.\n\nCopyright\n---------\n\n2012-2019, The Open Microscopy Environment\n\n.. _PyGithub: https://github.com/PyGithub/PyGithub\n.. _pep8: https://pypi.python.org/pypi/pep8\n.. _flake8: https://pypi.python.org/pypi/flake8\n.. _snoopys-sandbox: https://github.com/ome/snoopys-sandbox\n.. _snoopys-sandbox-2: https://github.com/ome/snoopys-sandbox-2\n.. _Travis: https://travis-ci.org/ome/scc\n.. _OME-contributing: https://ome-contributing.readthedocs.io/en/latest/scc.html\n\n\n\n",
"bugtrack_url": null,
"license": "GPLv2",
"summary": "OME tools for managing the git(hub) workflow",
"version": "0.19.1",
"project_urls": {
"Homepage": "https://github.com/ome/scc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c3d0ec58e1b972c6cf5f9881bbc58f4a81203d9e774ca99a2e075f4e192611a",
"md5": "99ce7284cf752b1196d47616b61ffa2c",
"sha256": "c1a63ac2dfe11d83036ffca1f8b7199d5228f980e6184366aa5a38a879bba0e4"
},
"downloads": -1,
"filename": "scc-0.19.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99ce7284cf752b1196d47616b61ffa2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 48212,
"upload_time": "2023-06-02T11:12:28",
"upload_time_iso_8601": "2023-06-02T11:12:28.661621Z",
"url": "https://files.pythonhosted.org/packages/0c/3d/0ec58e1b972c6cf5f9881bbc58f4a81203d9e774ca99a2e075f4e192611a/scc-0.19.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5bea6a1e140b4a5a0eb40d45fcbdc5c8e88789b97e052b5c9baae8abcaa4f8bd",
"md5": "cd04a4b2a92ca63b97c5f3806888fd9c",
"sha256": "dc12ac91bb807ea66fbbc68f6edf3f56523d42e3e92428e05ac11d4f4b4a6359"
},
"downloads": -1,
"filename": "scc-0.19.1.tar.gz",
"has_sig": false,
"md5_digest": "cd04a4b2a92ca63b97c5f3806888fd9c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 47879,
"upload_time": "2023-06-02T11:12:30",
"upload_time_iso_8601": "2023-06-02T11:12:30.412951Z",
"url": "https://files.pythonhosted.org/packages/5b/ea/6a1e140b4a5a0eb40d45fcbdc5c8e88789b97e052b5c9baae8abcaa4f8bd/scc-0.19.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-02 11:12:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ome",
"github_project": "scc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "scc"
}
JSON
