[](https://travis-ci.org/lsst-sqre/sqre-codekit)
# sqre-codekit
LSST DM SQuaRE misc. code management tools
## Installation
sqre-codekit runs on Python 3.5 or newer. You can install it with
`bash pip install sqre-codekit `
This will also install dependencies: github3, urllib3, requests, progress and gitpython.
## Example usage
To generate a personal user token (you will be prompted for your password):
`bash github-auth -u {{username}} `
Or to generate a token with delete privileges:
`bash github-auth -u {{username}} --delete-role `
To clone all github.com/lsst repos into an GitHub organization called {{username}}-shadow:
`bash github-fork-repos -u {{username}} --org {{username}}-shadow `
You’ll need to create this shadow organization in advance. Working in a shadow organization is useful for testing.
If you want to take a recent fork, you will need to delete the existing shadow repos first:
`bash github-delete-shadow -u {{username}} `
That requires a token with delete privileges.
To get more debugging information, set your DM_SQUARE_DEBUG variable before running any command, or use the -d debug flag on the command line.
## Available commands
github-auth: create a GitHub authentication token.
github-fork-repos: fork repositories into a shadow GitHub organization.
github-list-repos: list repositories in a GitHub organization, showing teams.
github-mv-repos-to-team: move repositories from one team to another.
github-tag-version: tag all repositories in a GitHub org using a team-based scheme.
lsst-bp: upgrade LSST DM code to [RFC-45](https://jira.lsstcorp.org/browse/RFC-45)-style.
Use the –help flag with any command to learn more.
## Development
To develop codekit, create a Python virtual environment, and
`bash git clone https://github.com/lsst-sqre/sqre-codekit.git cd sqre-codekit virtualenv venv . venv/bin/activate pip install -r requirements.txt python setup.py develop `
Note that all scripts (in codekit/cli) are installed using setuptools entry_points. See setup.py.
Tests can be run with [pytest](http://pytest.org/latest/):
`bash py.test tests `
4 maintainers
Metadata
4 maintainers
Release files for sqre-codekit 4.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sqre-codekit-4.0.1.tar.gz | 17.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sqre_codekit-4.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 40.4 kB
Release files / sqre-codekit-4.0.1.tar.gz
| Download URL | sqre-codekit-4.0.1.tar.gz |
|---|---|
| Size | 17.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
671405a61a52141ca73a6a51310d0655d4a814785715d139211bbdc82b05016f
|
|
BLAKE2b-256 checksum How to use checksums |
ccad830dc4f0d51b25b3b0cfff167e73b2c6fa707a45de84db1c2e1001e86399
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sqre_codekit-4.0.1-py3-none-any.whl
| Download URL | sqre_codekit-4.0.1-py3-none-any.whl |
|---|---|
| Size | 22.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3b936c64077b8cdad9b8a2388aed56017483ba3a6b73056acc7aa8e7fbc2b528
|
|
BLAKE2b-256 checksum How to use checksums |
327d5992150d726d6939c7a65ce426500f75b81a51d3cc1adac40cfb10cfc1d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
](https://travis-ci.org/lsst-sqre/sqre-codekit){kind=link}