# Roseingrave
Massively scalable musical source comparator.
See the
[documentation](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md)
for detailed documentation.
## Installation
Install the package through pip (recommended to do in a virtual environment):
```bash
$ python3 -m pip install roseingrave
```
The package will be added as a top-level command:
```bash
$ roseingrave --help
```
Create a folder to store all your input/output files. In this folder, place your
OAuth credentials file (see
[Credentials](https://github.com/scarlatti/roseingrave#credentials))
and all required and optional input files.
See the
[documentation](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md)
for customizing filepaths and the expected input file formats.
## Credentials
The package interacts with Google Sheets through the
[`gspread` package](https://docs.gspread.org/en/latest/).
You can enable an OAuth Client to create, access, and edit spreadsheets with
your email.
To enable the OAuth Client, follow these steps:
1. Go to the [Google Developers Console](https://console.cloud.google.com/).
2. Log in with the email account you want to use with the OAuth Client. All
created spreadsheets will be owned by this account in Google Drive.
3. Create a new project.
4. Go to the [API Library](https://console.cloud.google.com/apis/library).
5. In the search bar, search for "Google Drive API", select it, and enable it.
6. Go back to the API library. In the search bar, search for "Google Sheets
API", select it, and enable it.
7. Go to the
[OAuth Consent Screen](https://console.cloud.google.com/apis/credentials/consent)
tab.
8. If prompted, select "External" for the User Type.
9. On the "App Information" page, enter an app name. Select your email address
for the support email. Scroll down to the bottom and enter your email address
for the developer contact information. Click "Save and Continue".
10. On the "Scopes" page, click "Save and Continue".
11. On the "Test Users" page, add your email address as a user. Click "Save and
Continue".
12. On the summary page, scroll to the bottom and click "Back to Dashboard".
13. Go to the [Credentials](https://console.cloud.google.com/apis/credentials)
tab.
14. At the top of the page, select "+ Create credentials" > "OAuth client ID".
15. For the application type, select "Desktop app". Name your credentials.
Click "Create". Click "Ok" at the popup.
16. In the table labeled "OAuth 2.0 Client IDs", locate the credentials you just
created. Click the download button at the end of the row.
17. Rename the file to `credentials.json` and place it in the root directory of
where you'll be running the commands. (You can customize this in the
[settings](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md#settings-optional)
file).
If you've never authorized the app or if your authorization has expired, you'll
be given a link in the console for you to visit in order to refresh or create
an authorization token. Go to the url, select your email, click "Continue",
allow access to your Drive files and Sheets spreadsheets, and click "Continue".
This should authenticate you, and the command should continue running.
Once the authorization is successful, the `authorized_user.json` file will be
created in the same directory as `"credentials"`.
## Basic Usage
Create the piece definitions and volunteer definitions files as explained in the
[documentation](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md#input-files).
If desired, create the settings file and/or the template file. Save all the
files in the proper locations as defined by the
[default settings file](https://github.com/scarlatti/roseingrave/blob/main/src/roseingrave/defaults/roseingrave.json)
or by your own settings file.
Based on your definition files, create the volunteer spreadsheets:
```bash
$ roseingrave create_sheet
```
After volunteers have filled out their spreadsheets, export the data:
```bash
$ roseingrave volunteer_summary
```
Extract the data for each piece:
```bash
$ roseingrave piece_summary
```
Compile all the piece data into the summary file:
```bash
$ roseingrave compile_pieces
```
Create the summary spreadsheet with the data from the summary file:
```bash
$ roseingrave import_summary
```
Fill out the summary columns as appropriate, then export the summary spreadsheet
into the summary file:
```bash
$ roseingrave export_summary
```
See the
[commands documentation](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md#commands)
for all commands and their arguments and options.
Raw data
{
"_id": null,
"home_page": "https://github.com/scarlatti/roseingrave",
"name": "roseingrave",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "digital humanities",
"author": "Joseph Lou",
"author_email": "jdlou@princeton.edu",
"download_url": "https://files.pythonhosted.org/packages/04/00/51a98160e110293f5f49be310bd26c625bdf38dacf3b02361482d4be9085/roseingrave-1.1.0.tar.gz",
"platform": null,
"description": "# Roseingrave\n\nMassively scalable musical source comparator.\n\nSee the\n[documentation](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md)\nfor detailed documentation.\n\n## Installation\n\nInstall the package through pip (recommended to do in a virtual environment):\n\n```bash\n$ python3 -m pip install roseingrave\n```\n\nThe package will be added as a top-level command:\n\n```bash\n$ roseingrave --help\n```\n\nCreate a folder to store all your input/output files. In this folder, place your\nOAuth credentials file (see\n[Credentials](https://github.com/scarlatti/roseingrave#credentials))\nand all required and optional input files.\n\nSee the\n[documentation](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md)\nfor customizing filepaths and the expected input file formats.\n\n## Credentials\n\nThe package interacts with Google Sheets through the\n[`gspread` package](https://docs.gspread.org/en/latest/).\nYou can enable an OAuth Client to create, access, and edit spreadsheets with\nyour email.\n\nTo enable the OAuth Client, follow these steps:\n\n1. Go to the [Google Developers Console](https://console.cloud.google.com/).\n2. Log in with the email account you want to use with the OAuth Client. All\n created spreadsheets will be owned by this account in Google Drive.\n3. Create a new project.\n4. Go to the [API Library](https://console.cloud.google.com/apis/library).\n5. In the search bar, search for \"Google Drive API\", select it, and enable it.\n6. Go back to the API library. In the search bar, search for \"Google Sheets\n API\", select it, and enable it.\n7. Go to the\n [OAuth Consent Screen](https://console.cloud.google.com/apis/credentials/consent)\n tab.\n8. If prompted, select \"External\" for the User Type.\n9. On the \"App Information\" page, enter an app name. Select your email address\n for the support email. Scroll down to the bottom and enter your email address\n for the developer contact information. Click \"Save and Continue\".\n10. On the \"Scopes\" page, click \"Save and Continue\".\n11. On the \"Test Users\" page, add your email address as a user. Click \"Save and\n Continue\".\n12. On the summary page, scroll to the bottom and click \"Back to Dashboard\".\n13. Go to the [Credentials](https://console.cloud.google.com/apis/credentials)\n tab.\n14. At the top of the page, select \"+ Create credentials\" > \"OAuth client ID\".\n15. For the application type, select \"Desktop app\". Name your credentials.\n Click \"Create\". Click \"Ok\" at the popup.\n16. In the table labeled \"OAuth 2.0 Client IDs\", locate the credentials you just\n created. Click the download button at the end of the row.\n17. Rename the file to `credentials.json` and place it in the root directory of\n where you'll be running the commands. (You can customize this in the\n [settings](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md#settings-optional)\n file).\n\nIf you've never authorized the app or if your authorization has expired, you'll\nbe given a link in the console for you to visit in order to refresh or create\nan authorization token. Go to the url, select your email, click \"Continue\",\nallow access to your Drive files and Sheets spreadsheets, and click \"Continue\".\nThis should authenticate you, and the command should continue running.\n\nOnce the authorization is successful, the `authorized_user.json` file will be\ncreated in the same directory as `\"credentials\"`.\n\n## Basic Usage\n\nCreate the piece definitions and volunteer definitions files as explained in the\n[documentation](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md#input-files).\nIf desired, create the settings file and/or the template file. Save all the\nfiles in the proper locations as defined by the\n[default settings file](https://github.com/scarlatti/roseingrave/blob/main/src/roseingrave/defaults/roseingrave.json)\nor by your own settings file.\n\nBased on your definition files, create the volunteer spreadsheets:\n\n```bash\n$ roseingrave create_sheet\n```\n\nAfter volunteers have filled out their spreadsheets, export the data:\n\n```bash\n$ roseingrave volunteer_summary\n```\n\nExtract the data for each piece:\n\n```bash\n$ roseingrave piece_summary\n```\n\nCompile all the piece data into the summary file:\n\n```bash\n$ roseingrave compile_pieces\n```\n\nCreate the summary spreadsheet with the data from the summary file:\n\n```bash\n$ roseingrave import_summary\n```\n\nFill out the summary columns as appropriate, then export the summary spreadsheet\ninto the summary file:\n\n```bash\n$ roseingrave export_summary\n```\n\nSee the\n[commands documentation](https://github.com/scarlatti/roseingrave/blob/main/Documentation.md#commands)\nfor all commands and their arguments and options.\n",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "A massively scalable document source comparator, using Google Spreadsheets API + Python.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/scarlatti/roseingrave",
"Repository": "https://github.com/scarlatti/roseingrave"
},
"split_keywords": [
"digital",
"humanities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ddbcb1061e9f8188acb82f3ba68e2450a2583093f7b094ad3e09fb127692fdc0",
"md5": "90679ba8cddffe1091ac08e96be88473",
"sha256": "ddd4cdd396965f26e6745af64ef1aed65b3ab4c0df745a9650160ad508f866b2"
},
"downloads": -1,
"filename": "roseingrave-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90679ba8cddffe1091ac08e96be88473",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 45171,
"upload_time": "2023-06-13T17:57:56",
"upload_time_iso_8601": "2023-06-13T17:57:56.392508Z",
"url": "https://files.pythonhosted.org/packages/dd/bc/b1061e9f8188acb82f3ba68e2450a2583093f7b094ad3e09fb127692fdc0/roseingrave-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "040051a98160e110293f5f49be310bd26c625bdf38dacf3b02361482d4be9085",
"md5": "91bd62063eaef3a2a1e52bf253ae3d0d",
"sha256": "ff350ac16f439f761be37933c24bd1ff2b12d45415a766697e4c022163a998c7"
},
"downloads": -1,
"filename": "roseingrave-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "91bd62063eaef3a2a1e52bf253ae3d0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 35846,
"upload_time": "2023-06-13T17:57:58",
"upload_time_iso_8601": "2023-06-13T17:57:58.410482Z",
"url": "https://files.pythonhosted.org/packages/04/00/51a98160e110293f5f49be310bd26c625bdf38dacf3b02361482d4be9085/roseingrave-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-13 17:57:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scarlatti",
"github_project": "roseingrave",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "roseingrave"
}
JSON
