Skip to main content

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

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycognitocli-0.3.2.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

pycognitocli-0.3.2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file pycognitocli-0.3.2.tar.gz.

File metadata

  • Download URL: pycognitocli-0.3.2.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for pycognitocli-0.3.2.tar.gz
Algorithm Hash digest
SHA256 aeb3a80542c10c9bf91a044b1a712ea63444a29ddb1a35b503882bcf9e560126
MD5 6e2242023cc2a4863e087ef954a3e026
BLAKE2b-256 2a82d0607261a526197c09a9eb09423da38a6d8ca932be611bf733cd86687e23

See more details on using hashes here.

File details

Details for the file pycognitocli-0.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pycognitocli-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5f76a83b9548547386c6cbbb8514ad96852d7f8dd65f2b344fd7a7250f5b819c
MD5 177c050f3975d0b3a429d99d03b58ede
BLAKE2b-256 da22e3127479c74db84cbd8f785a2bfd6cd4e7fbe3131b761b89b73e28c49d69

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page