edx-ledger
#############################
.. note::
This README was auto-generated. Maintainer: please review its contents and
update all relevant sections. Instructions to you are marked with
"PLACEHOLDER" or "TODO". Update or remove those sections, and remove this
note when you are done.
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge| |status-badge|
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
--------------
.. code-block::
# Clone the repository
git clone git@github.com:iloveagent57/edx-ledger.git
cd edx-ledger
# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 edx-ledger
# or with pyenv
pyenv virtualenv 3.8 edx-ledger
Every time you develop something in this repo
---------------------------------------------
.. code-block::
# Activate the virtualenv
workon edx-ledger
# or with pyenv
pyenv activate edx-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`_
.. _deployment how-to: https://docs.openedx.org/projects/edx-ledger/how-tos/how-to-deploy-this-component.html
Getting Help
************
Documentation
=============
PLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.
.. _the documentation: https://docs.openedx.org/projects/edx-ledger
(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
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/edx-ledger/issues
For more information about these options, see the `Getting Help`_ page.
.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
.. _Getting Help: https://openedx.org/getting-help
License
*******
The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.
Please see `LICENSE.txt <LICENSE.txt>`_ for details.
Contributing
************
Contributions are very welcome.
Please read `How To Contribute <https://openedx.org/r/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`_.
.. _Open edX Code of Conduct: https://openedx.org/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.
.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/edx-ledger
Reporting Security Issues
*************************
Please do not report security issues in public. Please email security@tcril.org.
.. |pypi-badge| image:: https://img.shields.io/pypi/v/edx-ledger.svg
:target: https://pypi.python.org/pypi/edx-ledger/
:alt: PyPI
.. |ci-badge| image:: https://github.com/openedx/edx-ledger/workflows/Python%20CI/badge.svg?branch=main
:target: https://github.com/openedx/edx-ledger/actions
:alt: CI
.. |codecov-badge| image:: https://codecov.io/github/openedx/edx-ledger/coverage.svg?branch=main
:target: https://codecov.io/github/openedx/edx-ledger?branch=main
:alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/edx-ledger/badge/?version=latest
:target: https://edx-ledger.readthedocs.io/en/latest/
:alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/edx-ledger.svg
:target: https://pypi.python.org/pypi/edx-ledger/
:alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/openedx/edx-ledger.svg
:target: https://github.com/openedx/edx-ledger/blob/main/LICENSE.txt
:alt: License
.. TODO: Choose one of the statuses below and remove the other status-badge lines.
.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red
Change Log
##########
..
All enhancements and patches to edx_ledger will be documented
in this file. It adheres to the structure of https://keepachangelog.com/ ,
but in reStructuredText instead of Markdown (for ease of incorporation into
Sphinx documentation and the PyPI description).
This project adheres to Semantic Versioning (https://semver.org/).
.. There should always be an "Unreleased" section for changes pending release.
Unreleased
**********
*
[0.1.0] - 2022-12-14
************************************************
Added
=====
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/edx-ledger",
"name": "edx-ledger",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Python edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/47/ab/567a4acb6b38b0ac51d5b039b34763f5ca09018391c6cc65214146226c6d/edx-ledger-0.1.0.tar.gz",
"platform": null,
"description": "edx-ledger\n#############################\n\n.. note::\n\n This README was auto-generated. Maintainer: please review its contents and\n update all relevant sections. Instructions to you are marked with\n \"PLACEHOLDER\" or \"TODO\". Update or remove those sections, and remove this\n note when you are done.\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge| |status-badge|\n\nPurpose\n*******\n\nRecords transactions against a ledger, denominated in units of value.\n\nTODO: The ``README.rst`` file should start with a brief description of the repository and its purpose.\nIt should be described in the context of other repositories under the ``openedx``\norganization. It should make clear where this fits in to the overall Open edX\ncodebase and should be oriented towards people who are new to the Open edX\nproject.\n\nGetting Started\n***************\n\nDeveloping\n==========\n\nOne Time Setup\n--------------\n.. code-block::\n\n # Clone the repository\n git clone git@github.com:iloveagent57/edx-ledger.git\n cd edx-ledger\n\n # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it\n mkvirtualenv -p python3.8 edx-ledger\n # or with pyenv\n pyenv virtualenv 3.8 edx-ledger\n\n\nEvery time you develop something in this repo\n---------------------------------------------\n.. code-block::\n\n # Activate the virtualenv\n workon edx-ledger\n # or with pyenv\n pyenv activate edx-ledger\n\n # Grab the latest code\n git checkout main\n git pull\n\n # Install/update the dev requirements\n make requirements\n\n # Run just the tests\n make test\n\n # Run the tests and quality checks (to verify the status before you make any changes)\n make validate\n\n # Make a new branch for your changes\n git checkout -b <your_github_username>/<short_description>\n\n # Using your favorite editor, edit the code to make your change.\n vim ...\n\n # Run your new tests\n pytest ./tests/new_tests.py\n\n # Run all the tests and quality checks\n make validate\n\n # Commit all your changes\n git commit ...\n git push\n\n # Open a PR and ask for review.\n\nDeploying\n=========\n\nTODO: How can a new user go about deploying this component? Is it just a few\ncommands? Is there a larger how-to that should be linked here?\n\nPLACEHOLDER: For details on how to deploy this component, see the `deployment how-to`_\n\n.. _deployment how-to: https://docs.openedx.org/projects/edx-ledger/how-tos/how-to-deploy-this-component.html\n\nGetting Help\n************\n\nDocumentation\n=============\n\nPLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.\n\n.. _the documentation: https://docs.openedx.org/projects/edx-ledger\n\n(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)\n\nMore Help\n=========\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the\ncommunity.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.\n\nFor anything non-trivial, the best path is to open an issue in this\nrepository with as many details about the issue you are facing as you\ncan provide.\n\nhttps://github.com/openedx/edx-ledger/issues\n\nFor more information about these options, see the `Getting Help`_ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n.. _Getting Help: https://openedx.org/getting-help\n\nLicense\n*******\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see `LICENSE.txt <LICENSE.txt>`_ for details.\n\nContributing\n************\n\nContributions are very welcome.\nPlease read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features. However, please make sure\nto have a discussion about your new feature idea with the maintainers prior to\nbeginning development to maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\nThe Open edX Code of Conduct\n****************************\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nPeople\n******\n\nThe assigned maintainers for this component and other project details may be\nfound in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``\nfile in this repo.\n\n.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/edx-ledger\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email security@tcril.org.\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/edx-ledger.svg\n :target: https://pypi.python.org/pypi/edx-ledger/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/openedx/edx-ledger/workflows/Python%20CI/badge.svg?branch=main\n :target: https://github.com/openedx/edx-ledger/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/openedx/edx-ledger/coverage.svg?branch=main\n :target: https://codecov.io/github/openedx/edx-ledger?branch=main\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/edx-ledger/badge/?version=latest\n :target: https://edx-ledger.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/edx-ledger.svg\n :target: https://pypi.python.org/pypi/edx-ledger/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/openedx/edx-ledger.svg\n :target: https://github.com/openedx/edx-ledger/blob/main/LICENSE.txt\n :alt: License\n\n.. TODO: Choose one of the statuses below and remove the other status-badge lines.\n.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red\n\n\nChange Log\n##########\n\n..\n All enhancements and patches to edx_ledger will be documented\n in this file. It adheres to the structure of https://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n\n This project adheres to Semantic Versioning (https://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n**********\n\n*\n\n[0.1.0] - 2022-12-14\n************************************************\n\nAdded\n=====\n\n* First release on PyPI.\n\n\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "Records transactions against a ledger, denominated in units of value.",
"version": "0.1.0",
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2204a6a3e0fa5d4a22a1a72ef1102b66656747873ff3c639278dfac05bdb78c",
"md5": "4efa8127f00462741a33a045f9ab2ff5",
"sha256": "0a5409a1b0f1f77c1d1d25e8d3160ca5efe38ec72ffeaa79c23991670958d426"
},
"downloads": -1,
"filename": "edx_ledger-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4efa8127f00462741a33a045f9ab2ff5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 23111,
"upload_time": "2023-01-04T23:09:48",
"upload_time_iso_8601": "2023-01-04T23:09:48.523405Z",
"url": "https://files.pythonhosted.org/packages/e2/20/4a6a3e0fa5d4a22a1a72ef1102b66656747873ff3c639278dfac05bdb78c/edx_ledger-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "47ab567a4acb6b38b0ac51d5b039b34763f5ca09018391c6cc65214146226c6d",
"md5": "045580dd542c6271b4947acda44549c1",
"sha256": "e173b254ad7f3299d67374b43fcd5d7effb0a762bc6fec7b4af1301e11d46a58"
},
"downloads": -1,
"filename": "edx-ledger-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "045580dd542c6271b4947acda44549c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 26007,
"upload_time": "2023-01-04T23:09:50",
"upload_time_iso_8601": "2023-01-04T23:09:50.018226Z",
"url": "https://files.pythonhosted.org/packages/47/ab/567a4acb6b38b0ac51d5b039b34763f5ca09018391c6cc65214146226c6d/edx-ledger-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-04 23:09:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "openedx",
"github_project": "edx-ledger",
"lcname": "edx-ledger"
}
JSON
