# WBMaker
This alpha package helps establish an authenticated connection with a Wikibase instance and provides a number of functions for building items using the wikibaseintegrator package and working with Wikimedia pages (e.g., "item talk" pages) using the mwclient package. While it is simple enough to work with these packages separately, it is helpful to provide a lightweight layer of abstraction for many of the tasks needed in developing bot-based applications and data processing pipelines.
I am planning on building in additional functionality that I find most commonly used when developing bots that take action on Wikidata or another Wikibase instance.
## Installation
```pip install wbmaker```
or install from source
```git clone https://github.com/skybristol/wbmaker```
## Environment Variables
The WB class operates on a set of environment variables that set up and authorize interactions with a Wikibase instance, including Wikidata. These variables are required by one or both of the underlying packages, [wikibaseintegrator](https://github.com/LeMyst/WikibaseIntegrator) and [mwclient](https://github.com/mwclient/mwclient) used in wbmaker. Instantiating the class will prompt for the following basic variables and set them if not supplied in the operating environment.
* WB_URL: base URL for the Wikibase instance (e.g., https://www.wikidata.org/)
* WB_SPARQL_ENDPOINT: SPARQL endpoint for the Wikibase instance (e.g., https://query.wikidata.org/sparql)
* MEDIAWIKI_API: Mediawiki API URL for the Wikibase instance (e.g., https://www.wikidata.org/w/api.php)
# WBMaker
This alpha package helps establish an authenticated connection with a Wikibase instance and provides a number of functions for building items using the wikibaseintegrator package and working with Wikimedia pages (e.g., "item talk" pages) using the mwclient package. While it is simple enough to work with these packages separately, it is helpful to provide a lightweight layer of abstraction for many of the tasks needed in developing bot-based applications and data processing pipelines.
I am planning on building in additional functionality that I find most commonly used when developing bots that take action on Wikidata or another Wikibase instance.
## Installation
```pip install wbmaker```
or install from source
```git clone https://github.com/skybristol/wbmaker```
## Environment Variables
The WB class operates on a set of environment variables that set up and authorize interactions with a Wikibase instance, including Wikidata. These variables are required by one or both of the underlying packages, [wikibaseintegrator](https://github.com/LeMyst/WikibaseIntegrator) and [mwclient](https://github.com/mwclient/mwclient) used in wbmaker. Instantiating the class will prompt for the following basic variables and set them if not supplied in the operating environment.
* WB_URL: base URL for the Wikibase instance (e.g., https://www.wikidata.org/)
* WB_SPARQL_ENDPOINT: SPARQL endpoint for the Wikibase instance (e.g., https://query.wikidata.org/sparql)
* MEDIAWIKI_API: Mediawiki API URL for the Wikibase instance (e.g., https://www.wikidata.org/w/api.php)
* WB_BOT_USER_AGENT: the user agent string to use in actions; link to code and/or contact information encouraged (e.g., "MyBot/1.0")
If you will be making edits, the following are also required. If these are not provided, the login section of the class will not be invoked, and you will be limited to read-only operations.
* WB_BOT_USER: bot user name authorized to operate on the Wikibase instance
* WB_BOT_PASS: bot user's password
If you will be making edits, the following are also required. If these are not provided, the login section of the class will not be invoked, and you will be limited to read-only operations.
* WB_BOT_USER: bot user name authorized to operate on the Wikibase instance
* WB_BOT_PASS: bot user's password
Raw data
{
"_id": null,
"home_page": "https://github.com/skybristol/wbmaker",
"name": "wbmaker",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "wikibase, wikibaseintegrator, mwclient",
"author": "Sky Bristol",
"author_email": "skybristol@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b7/dc/195e9d694095c11cbb3536a5af08d1a2d59fa0b233ed478ba1741a641239/wbmaker-0.0.11.tar.gz",
"platform": null,
"description": "# WBMaker\nThis alpha package helps establish an authenticated connection with a Wikibase instance and provides a number of functions for building items using the wikibaseintegrator package and working with Wikimedia pages (e.g., \"item talk\" pages) using the mwclient package. While it is simple enough to work with these packages separately, it is helpful to provide a lightweight layer of abstraction for many of the tasks needed in developing bot-based applications and data processing pipelines.\n\nI am planning on building in additional functionality that I find most commonly used when developing bots that take action on Wikidata or another Wikibase instance.\n\n## Installation\n\n```pip install wbmaker```\n\nor install from source\n\n```git clone https://github.com/skybristol/wbmaker```\n\n## Environment Variables\nThe WB class operates on a set of environment variables that set up and authorize interactions with a Wikibase instance, including Wikidata. These variables are required by one or both of the underlying packages, [wikibaseintegrator](https://github.com/LeMyst/WikibaseIntegrator) and [mwclient](https://github.com/mwclient/mwclient) used in wbmaker. Instantiating the class will prompt for the following basic variables and set them if not supplied in the operating environment.\n\n* WB_URL: base URL for the Wikibase instance (e.g., https://www.wikidata.org/)\n* WB_SPARQL_ENDPOINT: SPARQL endpoint for the Wikibase instance (e.g., https://query.wikidata.org/sparql)\n* MEDIAWIKI_API: Mediawiki API URL for the Wikibase instance (e.g., https://www.wikidata.org/w/api.php)\n# WBMaker\nThis alpha package helps establish an authenticated connection with a Wikibase instance and provides a number of functions for building items using the wikibaseintegrator package and working with Wikimedia pages (e.g., \"item talk\" pages) using the mwclient package. While it is simple enough to work with these packages separately, it is helpful to provide a lightweight layer of abstraction for many of the tasks needed in developing bot-based applications and data processing pipelines.\nI am planning on building in additional functionality that I find most commonly used when developing bots that take action on Wikidata or another Wikibase instance.\n## Installation\n```pip install wbmaker```\nor install from source\n```git clone https://github.com/skybristol/wbmaker```\n## Environment Variables\nThe WB class operates on a set of environment variables that set up and authorize interactions with a Wikibase instance, including Wikidata. These variables are required by one or both of the underlying packages, [wikibaseintegrator](https://github.com/LeMyst/WikibaseIntegrator) and [mwclient](https://github.com/mwclient/mwclient) used in wbmaker. Instantiating the class will prompt for the following basic variables and set them if not supplied in the operating environment.\n* WB_URL: base URL for the Wikibase instance (e.g., https://www.wikidata.org/)\n* WB_SPARQL_ENDPOINT: SPARQL endpoint for the Wikibase instance (e.g., https://query.wikidata.org/sparql)\n* MEDIAWIKI_API: Mediawiki API URL for the Wikibase instance (e.g., https://www.wikidata.org/w/api.php)\n* WB_BOT_USER_AGENT: the user agent string to use in actions; link to code and/or contact information encouraged (e.g., \"MyBot/1.0\")\n\nIf you will be making edits, the following are also required. If these are not provided, the login section of the class will not be invoked, and you will be limited to read-only operations.\n* WB_BOT_USER: bot user name authorized to operate on the Wikibase instance\n* WB_BOT_PASS: bot user's password\n\nIf you will be making edits, the following are also required. If these are not provided, the login section of the class will not be invoked, and you will be limited to read-only operations.\n\n* WB_BOT_USER: bot user name authorized to operate on the Wikibase instance\n* WB_BOT_PASS: bot user's password",
"bugtrack_url": null,
"license": "MIT",
"summary": "Establishes a connection to a Wikibase instance and provides methods for interacting with it.",
"version": "0.0.11",
"project_urls": {
"Homepage": "https://github.com/skybristol/wbmaker"
},
"split_keywords": [
"wikibase",
" wikibaseintegrator",
" mwclient"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c600033b8191e3690f905aaa584686fef583162139c5d06e1e315684c602bda3",
"md5": "e79a5a23b9beca9d54a3195fed9b2a4e",
"sha256": "1bc91e64ea5babef673da037a92c20cc54d11466c2fc8a487e8df5d763beab48"
},
"downloads": -1,
"filename": "wbmaker-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e79a5a23b9beca9d54a3195fed9b2a4e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 8217,
"upload_time": "2024-08-12T11:43:53",
"upload_time_iso_8601": "2024-08-12T11:43:53.221077Z",
"url": "https://files.pythonhosted.org/packages/c6/00/033b8191e3690f905aaa584686fef583162139c5d06e1e315684c602bda3/wbmaker-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b7dc195e9d694095c11cbb3536a5af08d1a2d59fa0b233ed478ba1741a641239",
"md5": "c9e26915d690673460c1161f32d4c540",
"sha256": "dc33bc6124783ed01e19bbba0aadb9c2ddb6e50650702de9b603da06d583cfb1"
},
"downloads": -1,
"filename": "wbmaker-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "c9e26915d690673460c1161f32d4c540",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 7617,
"upload_time": "2024-08-12T11:43:54",
"upload_time_iso_8601": "2024-08-12T11:43:54.569665Z",
"url": "https://files.pythonhosted.org/packages/b7/dc/195e9d694095c11cbb3536a5af08d1a2d59fa0b233ed478ba1741a641239/wbmaker-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 11:43:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "skybristol",
"github_project": "wbmaker",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wbmaker"
}
JSON
