# OBC, the Open Badges Client
`obc` is a python library that provides a standard API to interact with Open
Badge platforms.
## Quick start guide
### Install OBC
`obc` is distributed as a python package. It can be installed using `pip` (or
any other package manager) from PyPI:
```
$ pip install obc
```
### Use providers in your application
Let say you want to issue an existing Open Badge Factory badge for a list of
recipients, an example implementation would look like:
```python
from obc.providers.obf import BadgeIssue, BadgeQuery, OBF
# Configure Open Badge Factory provider using your client identifier and secret
# key
obf = OBF(client_id="my_obf_client_id", client_secret="super_secret")
# Get the badge with the "badge_id" identifier
badge = await anext(obf.badges.read(query=BadgeQuery(id="badge_id")))
# We want to issue a badge for the following recipients
issue = BadgeIssue(
recipient=[
"jane@example.org",
"tarzan@example.org"
]
)
issue = await obf.badges.issue(badge, issue)
```
More details will follow in the upcoming documentation.
### Hack on the project
If you want to start contributing on the project, use the `bootstrap` Makefile
target to build the Docker development image:
```
$ make bootstrap
```
To run tests, type:
```
$ make test
```
And to lint sources, there is also a command for that:
```
$ make lint
```
If you had new dependencies to the project, you will have to rebuild the Docker
image (and the development environment):
```
$ make build && make dev
```
You can explore all other target using:
```
$ make help
```
## Contributing
This project is intended to be community-driven, so please, do not hesitate to
get in touch if you have any question related to our implementation or design
decisions.
We try to raise our code quality standards and expect contributors to follow
the recommandations from our
[handbook](https://openfun.gitbooks.io/handbook/content).
## License
This work is released under the MIT License (see [LICENSE](./LICENSE)).
Raw data
{
"_id": null,
"home_page": "https://github.com/openfun/open-badges-client",
"name": "obc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "Openbadge,API",
"author": "Open FUN (France Universite Numerique)",
"author_email": "fun.dev@fun-mooc.fr",
"download_url": "https://files.pythonhosted.org/packages/76/94/9d6150d8a80bc8969d67c01e8c2980a8ca689f5c6d0310a02bc5c1242d84/obc-2.1.0.tar.gz",
"platform": null,
"description": "# OBC, the Open Badges Client\n\n`obc` is a python library that provides a standard API to interact with Open\nBadge platforms.\n\n## Quick start guide\n\n### Install OBC\n\n`obc` is distributed as a python package. It can be installed using `pip` (or\nany other package manager) from PyPI:\n\n```\n$ pip install obc\n```\n\n### Use providers in your application\n\nLet say you want to issue an existing Open Badge Factory badge for a list of\nrecipients, an example implementation would look like:\n\n```python\nfrom obc.providers.obf import BadgeIssue, BadgeQuery, OBF\n\n# Configure Open Badge Factory provider using your client identifier and secret\n# key\nobf = OBF(client_id=\"my_obf_client_id\", client_secret=\"super_secret\")\n\n# Get the badge with the \"badge_id\" identifier\nbadge = await anext(obf.badges.read(query=BadgeQuery(id=\"badge_id\")))\n\n# We want to issue a badge for the following recipients\nissue = BadgeIssue(\n recipient=[\n \"jane@example.org\",\n \"tarzan@example.org\"\n ]\n)\n\nissue = await obf.badges.issue(badge, issue)\n```\n\nMore details will follow in the upcoming documentation.\n\n### Hack on the project\n\nIf you want to start contributing on the project, use the `bootstrap` Makefile\ntarget to build the Docker development image:\n\n```\n$ make bootstrap\n```\n\nTo run tests, type:\n\n```\n$ make test\n```\n\nAnd to lint sources, there is also a command for that:\n\n```\n$ make lint\n```\n\nIf you had new dependencies to the project, you will have to rebuild the Docker\nimage (and the development environment):\n\n```\n$ make build && make dev\n```\n\nYou can explore all other target using:\n\n```\n$ make help\n```\n\n## Contributing\n\nThis project is intended to be community-driven, so please, do not hesitate to\nget in touch if you have any question related to our implementation or design\ndecisions.\n\nWe try to raise our code quality standards and expect contributors to follow\nthe recommandations from our\n[handbook](https://openfun.gitbooks.io/handbook/content).\n\n## License\n\nThis work is released under the MIT License (see [LICENSE](./LICENSE)).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The Open Badges Client",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/openfun/open-badges-client"
},
"split_keywords": [
"openbadge",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "60d2b775ca14e11864da1181273ca4185c2c3aa087eab7bc20eed7e9db8d49b3",
"md5": "92cb1a6fd2e48ca53c505f3d95d48748",
"sha256": "5d2725ec50b4ae81dec38309344741c7a904dfa807d99f75df972c28956f8593"
},
"downloads": -1,
"filename": "obc-2.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "92cb1a6fd2e48ca53c505f3d95d48748",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10",
"size": 9618,
"upload_time": "2023-11-28T14:40:24",
"upload_time_iso_8601": "2023-11-28T14:40:24.872633Z",
"url": "https://files.pythonhosted.org/packages/60/d2/b775ca14e11864da1181273ca4185c2c3aa087eab7bc20eed7e9db8d49b3/obc-2.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76949d6150d8a80bc8969d67c01e8c2980a8ca689f5c6d0310a02bc5c1242d84",
"md5": "db2fbe9f9de96b01cdc19107e4e56fbe",
"sha256": "6cc4354f564e2fa5ddef8d49608ea3854d5e88cf4c1356bf5d0bf7f7438d708b"
},
"downloads": -1,
"filename": "obc-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "db2fbe9f9de96b01cdc19107e4e56fbe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10515,
"upload_time": "2023-11-28T14:40:26",
"upload_time_iso_8601": "2023-11-28T14:40:26.416826Z",
"url": "https://files.pythonhosted.org/packages/76/94/9d6150d8a80bc8969d67c01e8c2980a8ca689f5c6d0310a02bc5c1242d84/obc-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-28 14:40:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openfun",
"github_project": "open-badges-client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "obc"
}
JSON
