sqre-codekit
LSST DM SQuaRE misc. code management tools
Installation
sqre-codekit runs on Python 3.6 or newer. You can install it with
pip install sqre-codekit
Available commands
github-auth: Generate a GitHub authentication token.github-decimate-org: Delete repos and/or teams from a GitHub organization.github-fork-org: Fork repositories from one GitHub organization to another.github-get-ratelimit: Display the current github ReST API request ratelimit.github-list-repos: List repositories on Github using various criteria.github-mv-repos-to-team: Move repo(s) from one team to another.github-tag-release: Tag git repositories, in a GitHub org, that correspond to the products in a published eups distrib tag.github-tag-teams: Tag the head of the default branch of all repositories in a GitHub org which belong to the specified team(s).
Use the --help flag with any command to learn more.
Example usage
github-auth
To generate a personal user token (you will be prompted for your password):
github-auth -u {{username}}
Or to generate a token with delete privileges:
github-auth -u {{username}} --delete-role
github-fork-org
To clone all github.com/lsst repos into an GitHub
organization called {{username}}-shadow:
github-fork-org \
--dry-run \
--debug \
--src-org 'lsst' \
--dst-org '{{username}}-shadow' \
--token "$GITHUB_TOKEN" \
--team 'DM Auxilliaries' \
--team 'DM Externals' \
--team 'Data Management' \
--copy-teams
You'll need to create this shadow organization in advance. Working in a shadow organization is useful for testing.
github-decimate-org
If you want to take a recent fork, you will need to delete the existing shadow repos first:
github-decimate-org \
--dry-run \
--debug \
--org 'example' \
--token "$GITHUB_TOKEN" \
--delete-repos \
--delete-repos-limit 3 \
--delete-teams \
--delete-teams-limit 3
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.
github-tag-release
XXX
github-tag-teams
XXX
github-get-ratelimit
XXX
Development
To develop codekit, create a Python virtual environment, and
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
Unit tests can be run with pytest:
python setup.py test
or
pytest tests
4 maintainers
Metadata
4 maintainers
Release files for sqre-codekit 7.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sqre-codekit-7.5.0.tar.gz | 42.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sqre_codekit-7.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 81.7 kB
Release files / sqre-codekit-7.5.0.tar.gz
| Download URL | sqre-codekit-7.5.0.tar.gz |
|---|---|
| Size | 42.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
aebb28af76d367c6d313f5f234e789ee68f2d8107ff1b15636bb9ebbfcb52dc3
|
|
BLAKE2b-256 checksum How to use checksums |
5b2a2e354e14d257c93b74dcd66f726e029da12ae01a765e4fa1f9711b998a96
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.7
|
Release files / sqre_codekit-7.5.0-py3-none-any.whl
| Download URL | sqre_codekit-7.5.0-py3-none-any.whl |
|---|---|
| Size | 39.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6aa92589a2a8052dc0a3f41850da6317d9d0ef09400d61316e60ed5d696cdac4
|
|
BLAKE2b-256 checksum How to use checksums |
c7168a1b6efc2fcbfdd478e3551f74088bda49130e1ea996945843addb7a0611
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.7
|
Security for sqre-codekit 7.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
