Skip to main content

pycognitocli

CLI for https://pypi.org/project/pycognito/

Try:

pycognitocli -p "region_mypool" -a "myappid" -cs "myappsecret" token get -u "username" -pw 'password'

Or export following environment variables:

  • COGNITO_POOL_ID

  • COGNITO_APP_ID

  • COGNITO_APP_SECRET

  • COGNITO_USERNAME

  • COGNITO_PASSWORD

You do not have to give the password (or username) on command-line, the app can prompt for it

Docker

For more controlled deployments and to get rid of “works on my computer” -syndrome, we always make sure our software works under docker.

It’s also a quick way to get started with a standard development environment.

SSH agent forwarding

We need buildkit:

export DOCKER_BUILDKIT=1

And also the exact way for forwarding agent to running instance is different on OSX:

export DOCKER_SSHAGENT="-v /run/host-services/ssh-auth.sock:/run/host-services/ssh-auth.sock -e SSH_AUTH_SOCK=/run/host-services/ssh-auth.sock"

and Linux:

export DOCKER_SSHAGENT="-v $SSH_AUTH_SOCK:$SSH_AUTH_SOCK -e SSH_AUTH_SOCK"

Creating a development container

Build image, create container and start it (switch the 1234 port to the port from src/pycognitocli/defaultconfig.py):

docker build --ssh default --target devel_shell -t pycognitocli:devel_shell .
docker create --name pycognitocli_devel -v `pwd`":/app" -it `echo $DOCKER_SSHAGENT` pycognitocli:devel_shell
docker start -i pycognitocli_devel

pre-commit considerations

If working in Docker instead of native env you need to run the pre-commit checks in docker too:

docker exec -i pycognitocli_devel /bin/bash -c "pre-commit install"
docker exec -i pycognitocli_devel /bin/bash -c "pre-commit run --all-files"

You need to have the container running, see above. Or alternatively use the docker run syntax but using the running container is faster:

docker run -it --rm -v `pwd`":/app" pycognitocli:devel_shell -c "pre-commit run --all-files"

Test suite

You can use the devel shell to run py.test when doing development, for CI use the “tox” target in the Dockerfile:

docker build --ssh default --target tox -t pycognitocli:tox .
docker run -it --rm -v `pwd`":/app" `echo $DOCKER_SSHAGENT` pycognitocli:tox

Production docker

There’s a “production” target as well for running the application (change the “1234” port and “myconfig.toml” for config file):

docker build --ssh default --target production -t pycognitocli:latest .
docker run -it --rm pycognitocli:latest pycognitocli -p "region_mypool" -a "myappid" -cs "myappsecret" token get -u "username" -pw 'password'

Local Development

TLDR:

  • Create and activate a Python 3.8 virtualenv (assuming virtualenvwrapper):

    mkvirtualenv -p `which python3.8` my_virtualenv
  • change to a branch:

    git checkout -b my_branch
  • install Poetry: https://python-poetry.org/docs/#installation

  • Install project deps and pre-commit hooks:

    poetry install
    pre-commit install
    pre-commit run --all-files
  • Ready to go, try the following:

    pycognitocli --defaultconfig >config.toml
    pycognitocli -vv config.toml

Remember to activate your virtualenv whenever working on the repo, this is needed because pylint and mypy pre-commit hooks use the “system” python for now (because reasons).

Running “pre-commit run –all-files” and “py.test -v” regularly during development and especially before committing will save you some headache.

Metadata

Release files for pycognitocli 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pycognitocli 0.3.2
File Size Uploaded Provenance Actions
pycognitocli-0.3.2.tar.gz 5.3 kB Without provenance Details for pycognitocli-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pycognitocli 0.3.2
File Interpreter ABI Platform Actions
pycognitocli-0.3.2-py3-none-any.whl Python 3 none any Details for pycognitocli-0.3.2-py3-none-any.whl

Total release size: 10.4 kB

Release files / pycognitocli-0.3.2.tar.gz

Download URL pycognitocli-0.3.2.tar.gz
Size 5.3 kB
Tags Source
SHA-256 checksum
How to use checksums
aeb3a80542c10c9bf91a044b1a712ea63444a29ddb1a35b503882bcf9e560126
BLAKE2b-256 checksum
How to use checksums
2a82d0607261a526197c09a9eb09423da38a6d8ca932be611bf733cd86687e23
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.16

Release files / pycognitocli-0.3.2-py3-none-any.whl

Download URL pycognitocli-0.3.2-py3-none-any.whl
Size 5.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5f76a83b9548547386c6cbbb8514ad96852d7f8dd65f2b344fd7a7250f5b819c
BLAKE2b-256 checksum
How to use checksums
da22e3127479c74db84cbd8f785a2bfd6cd4e7fbe3131b761b89b73e28c49d69
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.16

Security for pycognitocli 0.3.2

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page