LSST Data Management SQuaRE code management tools
Project description
[](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 `
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sqre-codekit-4.1.0.tar.gz.
File metadata
- Download URL: sqre-codekit-4.1.0.tar.gz
- Upload date:
- Size: 19.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ef5cc9104c618c2e84f70f032865607c67da6d51ad92e18e65dc6e5103d27805 |
|
| MD5 | 2a98a49aa019ea19bdc41373bcd49792 |
|
| BLAKE2b-256 | ab769f2ac33007778c871399ddbda73a90d5ead17bbd353bfe390656c4e089c9 |
File details
Details for the file sqre_codekit-4.1.0-py3-none-any.whl.
File metadata
- Download URL: sqre_codekit-4.1.0-py3-none-any.whl
- Upload date:
- Size: 26.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 44456862df2440d36b9a3608ebedf6e3cbbb6dbc18f4f003b2ea5f8389d1aa5d |
|
| MD5 | 141ea680433eb8bf21ec3eb0717f5012 |
|
| BLAKE2b-256 | ccd3331d1142c368da12b585346545db8df8053ad3d30a07c4ae8191b142d767 |
](https://travis-ci.org/lsst-sqre/sqre-codekit){kind=link}