| Name | asc2mb JSON |
| Version |
0.7.2
JSON |
| download |
| home_page | |
| Summary | Manage your timetable by pasing the XML export from asc and format into two files suitable for upload into ManageBac |
| upload_time | 2023-05-06 04:10:39 |
| maintainer | |
| docs_url | None |
| author | Adam Morris |
| requires_python | >=3.7,<4.0 |
| license | MIT |
| keywords |
managebac
asc
timetable
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# aSc to ManageBac
## Getting started
Requires Python 3.6 or above. For Windows, install Python via the Microsoft Store. For Mac, install Python at [python.org](https://www.python.org). Installing Python also installs a package manager (called `pip`) that can install the command `asc2mb` into your command line environment.
After installing Python, open the terminal or command line or PowerShell, and peform the following:
```sh
pip install asc2mb
```
If for some reason the `pip` command doesn't work, you can manually install it by following [the relevant instructions](https://pip.pypa.io/en/stable/installing/) for your system.
### Upgrade
Should you need to update to the latest version, you can do:
```
pip install --upgrade asc2mb
```
## Use
After `pip install` worked, it is now installed on your path, and the command `asc2mb` should be available:
```
asc2mb ~/path/to/xml.xml ~/path/to/save/timetable.csv ~/path/to/save/classes.csv
```
It takes only a second to run. It reports how many records it processed.
## Algorithm
This script uses input from more than one international school to generate the expected output. The key to success is using aSc Divisions to match the `uniq_id`s found in ManageBac classes.
## Help
For built-in help, and list of options and their functionality:
```
asc2mb --help
```
## Miscellaneous
The command takes three required arguments, and there are additional options as well. The three required arguments tell the program where the xml file is located, and where to save the two csv files.
The options depend on your school's needs. For example, the class id is how ManageBac knows which class you are referring to, so that program helps you derive the class ID based on information contains in the xml file. It's up to you to ensure there are classes that have those IDs in ManageBac, but the program does produce a csv so that they can be uploaded in bulk.
By default, class id uses the pattern `{class_.short}_{division.name}`, which means "the short name of the class" plus an underscore, plus the name of the division." At the time of publication, having a different pattern is only possible by contacting the author (or, if you're a keen developer, add a pull request).
If you run the program without any options, it'll prompt you to enter them.
Raw data
{
"_id": null,
"home_page": "",
"name": "asc2mb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "ManageBac,aSc,timetable",
"author": "Adam Morris",
"author_email": "adam.morris@fariaedu.com",
"download_url": "https://files.pythonhosted.org/packages/c3/6e/81a6411013ed3845c47c338636ea474ac3a37e9efcbf50a52af5291a98b7/asc2mb-0.7.2.tar.gz",
"platform": null,
"description": "# aSc to ManageBac\n\n## Getting started\n\nRequires Python 3.6 or above. For Windows, install Python via the Microsoft Store. For Mac, install Python at [python.org](https://www.python.org). Installing Python also installs a package manager (called `pip`) that can install the command `asc2mb` into your command line environment.\n\nAfter installing Python, open the terminal or command line or PowerShell, and peform the following:\n\n```sh\npip install asc2mb\n```\n\nIf for some reason the `pip` command doesn't work, you can manually install it by following [the relevant instructions](https://pip.pypa.io/en/stable/installing/) for your system.\n\n### Upgrade\n\nShould you need to update to the latest version, you can do:\n\n```\npip install --upgrade asc2mb\n```\n\n## Use\n\nAfter `pip install` worked, it is now installed on your path, and the command `asc2mb` should be available:\n\n```\nasc2mb ~/path/to/xml.xml ~/path/to/save/timetable.csv ~/path/to/save/classes.csv\n```\n\nIt takes only a second to run. It reports how many records it processed.\n\n## Algorithm\n\nThis script uses input from more than one international school to generate the expected output. The key to success is using aSc Divisions to match the `uniq_id`s found in ManageBac classes.\n\n## Help\n\nFor built-in help, and list of options and their functionality:\n\n```\nasc2mb --help\n```\n\n## Miscellaneous\n\nThe command takes three required arguments, and there are additional options as well. The three required arguments tell the program where the xml file is located, and where to save the two csv files. \n\nThe options depend on your school's needs. For example, the class id is how ManageBac knows which class you are referring to, so that program helps you derive the class ID based on information contains in the xml file. It's up to you to ensure there are classes that have those IDs in ManageBac, but the program does produce a csv so that they can be uploaded in bulk.\n\nBy default, class id uses the pattern `{class_.short}_{division.name}`, which means \"the short name of the class\" plus an underscore, plus the name of the division.\" At the time of publication, having a different pattern is only possible by contacting the author (or, if you're a keen developer, add a pull request).\n\nIf you run the program without any options, it'll prompt you to enter them.\n\n\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Manage your timetable by pasing the XML export from asc and format into two files suitable for upload into ManageBac",
"version": "0.7.2",
"project_urls": null,
"split_keywords": [
"managebac",
"asc",
"timetable"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "518506ff47dd79814be54e403a888a09edf88cba3f9a51507af1e6ff2a88161a",
"md5": "09d7d5c9b07a0d024f73000f239d6762",
"sha256": "7292c5dda9e0dc35c5116ed49591f1aa2dd41416e28bb95958f640c459482065"
},
"downloads": -1,
"filename": "asc2mb-0.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09d7d5c9b07a0d024f73000f239d6762",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 8966,
"upload_time": "2023-05-06T04:10:37",
"upload_time_iso_8601": "2023-05-06T04:10:37.975259Z",
"url": "https://files.pythonhosted.org/packages/51/85/06ff47dd79814be54e403a888a09edf88cba3f9a51507af1e6ff2a88161a/asc2mb-0.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c36e81a6411013ed3845c47c338636ea474ac3a37e9efcbf50a52af5291a98b7",
"md5": "20bfab1f183b51cd8d68d82ecc59f0e0",
"sha256": "e5772371a02dc5c92175668f5ddb1a1da9f39711bbdcdb5bd5740a7f3cde218e"
},
"downloads": -1,
"filename": "asc2mb-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "20bfab1f183b51cd8d68d82ecc59f0e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 7632,
"upload_time": "2023-05-06T04:10:39",
"upload_time_iso_8601": "2023-05-06T04:10:39.313252Z",
"url": "https://files.pythonhosted.org/packages/c3/6e/81a6411013ed3845c47c338636ea474ac3a37e9efcbf50a52af5291a98b7/asc2mb-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-06 04:10:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "asc2mb"
}
