openedx-ledger
Purpose
Records transactions against a ledger, denominated in units of value.
TODO: The README.rst file should start with a brief description of the repository and its purpose. It should be described in the context of other repositories under the openedx organization. It should make clear where this fits in to the overall Open edX codebase and should be oriented towards people who are new to the Open edX project.
Getting Started
Developing
One Time Setup
# Clone the repository
git clone git@github.com:iloveagent57/openedx-ledger.git
cd openedx-ledger
# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 openedx-ledger
# or with pyenv
pyenv virtualenv 3.8 openedx-ledgerEvery time you develop something in this repo
# Activate the virtualenv
workon openedx-ledger
# or with pyenv
pyenv activate openedx-ledger
# Grab the latest code
git checkout main
git pull
# Install/update the dev requirements
make requirements
# Run just the tests
make test
# Run the tests and quality checks (to verify the status before you make any changes)
make validate
# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>
# Using your favorite editor, edit the code to make your change.
vim ...
# Run your new tests
pytest ./tests/new_tests.py
# Run all the tests and quality checks
make validate
# Commit all your changes
git commit ...
git push
# Open a PR and ask for review.Deploying
TODO: How can a new user go about deploying this component? Is it just a few commands? Is there a larger how-to that should be linked here?
PLACEHOLDER: For details on how to deploy this component, see the deployment how-to
Getting Help
Documentation
PLACEHOLDER: Start by going through the documentation. If you need more help see below.
(TODO: Set up documentation)
More Help
If you’re having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.
For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.
https://github.com/openedx/openedx-ledger/issues
For more information about these options, see the Getting Help page.
License
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt for details.
Contributing
Contributions are very welcome. Please read How To Contribute for details.
This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.
The Open edX Code of Conduct
All community members are expected to follow the Open edX Code of Conduct.
People
The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.
Reporting Security Issues
Please do not report security issues in public. Please email security@tcril.org.
Change Log
Unreleased
[0.1.1] - 2023-01-05
Added
Package renamed from edx-ledger to openedx-ledger
[0.1.0] - 2023-01-04
Added
First release on PyPI.
1 maintainer
Metadata
1 maintainer
Release files for openedx-ledger 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openedx-ledger-0.1.1.tar.gz | 26.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openedx_ledger-0.1.1-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 49.5 kB
Release files / openedx-ledger-0.1.1.tar.gz
| Download URL | openedx-ledger-0.1.1.tar.gz |
|---|---|
| Size | 26.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4bb9a7e807ced677faa3673f5bf463fd25d117822fc432e02d1d5b2cbd17f2d0
|
|
BLAKE2b-256 checksum How to use checksums |
024969ce3c25144bcfa1966989ab77f20dddc43bf6f80141fb65628a7866e41c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / openedx_ledger-0.1.1-py2.py3-none-any.whl
| Download URL | openedx_ledger-0.1.1-py2.py3-none-any.whl |
|---|---|
| Size | 23.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
003faa54161d5b7d1d7455dad46aff17b75fdfb0e9d85e1e5a3f331599ed90de
|
|
BLAKE2b-256 checksum How to use checksums |
eebdaccac701691b073aee2137e3623d120bd796a930b042d122c18c6b33d506
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
