https://github.com/mitodl/social-auth-mitxpro

https://github.com/mitodl/social-auth-mitxpro

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mitodl/social-auth-mitxpro
• Owner: mitodl
• License: bsd-3-clause
• Created: 2019-02-25T16:33:19.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T23:06:09.000Z (9 months ago)
• Last Synced: 2024-04-14T05:09:48.163Z (8 months ago)
• Language: Python
• Size: 406 KB
• Stars: 1
• Watchers: 22
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

social-auth-mitxpro

---

#### Prerequisites

- [`pyenv`](https://github.com/pyenv/pyenv#installation) for managing python versions

  - Install `python3.8` and `python3.11`

- `pip install tox tox-pyenv` for running tests and discovering python versions from `pyenv`

- [`poetry`](https://poetry.eustace.io/docs/#installation) for building, testing, and releasing

If this is your first time using `poetry`, you'll need to configure your pypi credentials via:

- Configure pypi repository:

  - `poetry config http-basic.pypi USERNAME PASSWORD`

- Configure testpypi repository:

  - `poetry config repositories.testpypi https://test.pypi.org/legacy`

  - `poetry config http-basic.testpypi USERNAME PASSWORD`

**NOTE:** when running `poetry` commands, particularly `pylint` and `black`, you must `python3.6`

#### Testing

You can just run `tox` locally to test, lint, and check formatting in the supported python versions. This works by having `tox` manage the virtualenvs, which `poetry` then detects and uses.

Run individual commands can be run interactively in a `poetry shell` session or directly via `poetry run CMD`:

- `pytest` - run python tests

- `ruff check` - lint python code

- `ruff format` - format python code

#### Building

- `poetry build` - builds a pip-installable package into `dist/`

#### Releasing

- `poetry version VERSION` - bump the project version (see `poetry version --help` for details)

- `poetry publish -r testpypi` - publish to testpypi

- `poetry publish` - publish to pypi