Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.24 KB

README.md

File metadata and controls

54 lines (37 loc) · 2.24 KB
Raw

Sharing Scores with Dropbox

The aim of this project is to have a tool to automatize the process of generating an HTML code containing a music score, just ready to be shared in Wordpress.

This project has been desinged to be used together with the Wordpress Plugin: Restricted User Access. More details in how to use in the setup section.

A score is composed by:

  • Title.
  • Link to the song of it.
  • A list of instruments with their corresponding Dropbox link.

Setup

Dropbox API

This project uses the Dropbox API for Python. So an App is needed (please check here). Once the app is created, you will need to save the App key and App secret and setup them as enviroment variables:

$env:DROPBOX_APP_KEY = "<APP_KEY>"
$env:DROPBOX_APP_SECRET = "<APP_SECRET>"

After that, we need to generate the refresh_token. For this, use the helper dropboxAPI.py module and follow the steps:

> poetry run python src/dropboxAPI.py

Then, save it as another environment var:

$env:DROPBOX_REFRESH_TOKEN = "<REFRESH_TOKEN>"

Restrict User Access

As mentioned before, this project has been designed to be used with the Wordpress Plugin Restricted User Access. Basically, the plugins offers the possibility to add access rules to the users, allowing them to see or not specific content by specifiying restrict-levels.

Config

The application.conf contains a JSON object that contains a list of items. Each item have the following properties:

  • name. Represents the name that will be used to identify in the folder the correct file/folder to be shared.
  • restrict-level. Represents the restrict level defined in the plugin that reffers to this item. It will be necessary to use the same values as defined in the plugin.
  • publishName. Represents the name that will appear in the Wordpress entry.

Run

This project uses Poetry, so once configured, you can launch the program by calling:

> poetry run python src/generateScore.py