wikimovimentobrasil / quickstatements3 Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 0.0 163 KB

Repository for the development of a new version of QuickStatements

Home Page: https://qs-dev.toolforge.org

License: MIT License

Dockerfile 0.67% Makefile 0.23% Shell 0.45% Python 90.12% HTML 8.53%

quickstatements3's Introduction

quickstatements3

Repository for the development of a new version of QuickStatements

Local development HOW TO

Required tools:

Docker
Make

To build the development container

> make build

To run a shell inside the container

> make shell

Make sure that you have an env file inside the local etc/ dir. This file contains all the ENVIRONMENT VARIABLES used by the system and must never be added to your git repo.

To generate a good secret key you can run with python 3.6+

python -c "import secrets; print(secrets.token_urlsafe())"

If you are running this container for the first time, you have to initialize the database and create a superuser for the Django ADMIN

> cd src
> python manage.py migrate
> python manage.py createsuperuser

Now that everything is set up, we can start Quickstatements. We have 2 ways of doing that:

from inside the container, running

>./cmd_run.sh

from our Makefile, running

> make run

Now Quickstatements is available at http://localhost:8765/

OAuth

This application uses OAuth2 with the Mediawiki provider.

The grants we probably need are

Perform high volume activity
- High-volume (bot) access
Interact with pages
- Edit existing pages
- Edit protected pages (risk rating: vandalism)
- Create, edit, and move pages

Consumer

After registering a consumer in

https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration

This application is listening on /auth/callback/, so, when registering, define the callback endpoint as https://yourdomain.com/auth/callback/.

After receveing the consumer id and secret, setup OAUTH_CLIENT_ID and OAUTH_CLIENT_SECRET environment variables.

Developer access

If you want to login with a developer access token, you need to register for yourself an owner-only consumer application for OAuth2. Follow the form and be sure to tick "This consumer is for use only by ".

Toolforge deployment

Login and enter into the tool user
Clone the repository at ~/www/python/
Update uwsgi.ini with the toolname. In this case, its qs-dev
Create the environment variables file at ~/www/python/src/.env with install -m 600 /dev/null ~/www/python/src/.env so that only your user can read it.
Run deploy.sh
Logs are at ~/uwsgi.log

quickstatements3's People

Contributors

Stargazers

Watchers

quickstatements3's Issues

Allow WIKIBASE API endpoint to be SET using settings

Allow entity creation with CREATE and property adding with LAST: integrate with API

Move username API logic into api app

Deploy on Toolforge

Add a simple css framework

I think we could use PicoCSS: https://picocss.com

Here's a preview: https://4mrnhq.csb.app

It's minimal and focuses on semantic HTML. Plus, we won't end up with a lot of classes like in Bootstrap...

Last batches automatic reload

Create JS code to automaticaly reload last batches / last batches by user page. Use AJAX.

Implement CI

We could have a basic CI. I think I would like to have some static analysis and basic formatting.

Create new batch

Allow user to keep v1/csv preference

This is good if the user is submitting one batch after the other, so that they don't need to keep selecting csv time and time again if they prefer using csv.

Fix globe coordinates by wiki

When using test.wikidata.org, globecoordinates don't work because the parser uses www.wikidata.org's Q2 as a defined globe

Create custom exceptions and messages for API errors

For example, a custom error message saying the value is incorrect when we receive the following error response:

{'code': 'invalid-value', 'message': "Invalid value at '/statement/value/content'", 'context': {'path': '/statement/value/content'}}

In the views, show QIDs with their labels using the user's language

Add syntax to remove references from statement

-s1234
-S1234

The value will be used to compare with existing references, and if a match is found, the system will remove the reference.

Add syntax to remove qualifiers from statement

-p1234

Search for a specific batch

Set batch status to blocked when a command fails

spawn background process to send batches

Batch CSV parser

Decide on proper selecting of wikibase URLs

The OAuth token we request is only valid for wikidata.org, and not test.wikidata.org for example. If the user wants to point to a different wikibase server, then the authentication should be different. As of know, wikibase url is selected as env var, and not as a dropdown/type when creating a new batch. Maybe we could allow users to select (1) wikidata, (2) test wikidata, or (3) custom server. Our OAuth token could allow editing on (1) and (2), and the user, when selecting (3), should provide its own direct token for us to use when authenticating.

Register OAuth2 application

We can register a owner-only application for personal use, in which we directly receive an access token.

To use generally, we need to register the app as an OAuth2 consumer, here: