Skip to content
πŸ€– The Okuna Social Network API
Python HTML Other
Branch: master
Clone or download
uiboy Merge pull request #574 from OkunaOrg/enhancement/exclude-users-commu…
…nities-from-tab

Enhancement/exclude users communities from tab
Latest commit 2fb5839 Oct 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci πŸ’š change cache prefix Sep 10, 2019
.docker Update compnay name references because facebook -_- Aug 10, 2019
.ebextensions πŸ› fix supervisord stop Oct 12, 2019
.elasticbeanstalk πŸ‘· add deploy circle ci job Nov 3, 2018
docs πŸ“ πŸ’¬ Change Openbook to Okuna and update the links Oct 1, 2019
locale 🌐 add missing locales Sep 20, 2019
media πŸ”§ add collect media fixtures Dec 20, 2018
openbook ♻️ add default, high and low rq queues and use accordingly Oct 10, 2019
openbook_auth ✨ add exclude_joined_communities boolean to api Oct 14, 2019
openbook_categories 🌐 add dutch, danish and hungarian to languages Sep 9, 2019
openbook_circles ♻️ add global custom testcase which mocks sending push notifications Aug 22, 2019
openbook_common Merge branch 'master' into feature/432-top-posts-feed-api Sep 20, 2019
openbook_communities πŸ‘Œ code review comments, change some func names and fix misses Sep 26, 2019
openbook_connections ♻️ add global custom testcase which mocks sending push notifications Aug 22, 2019
openbook_devices ♻️ add global custom testcase which mocks sending push notifications Aug 22, 2019
openbook_follows ♻️ add global custom testcase which mocks sending push notifications Aug 22, 2019
openbook_importer ♻️ add global custom testcase which mocks sending push notifications Aug 22, 2019
openbook_invitations 🚸 update user invite templates Oct 3, 2019
openbook_lists ♻️ add global custom testcase which mocks sending push notifications Aug 22, 2019
openbook_moderation 🌐 add dutch, danish and hungarian to languages Sep 9, 2019
openbook_notifications ♻️ add default, high and low rq queues and use accordingly Oct 10, 2019
openbook_posts ⚑️ tweak trending posts query performance Oct 16, 2019
openbook_tags ♻️ remove community circle Feb 8, 2019
openbook_translation βœ… update mockstrategyclass Aug 2, 2019
utils πŸ€¦β€β™‚ Yeah seriously... Jun 1, 2019
video_encoding Revert "πŸ› fix can't delete post if file no longer exists" Oct 10, 2019
.bandit πŸ”§ skip django video encoder from bandit Sep 11, 2019
.coveragerc πŸ’š omg try to omit venv again! Oct 11, 2018
.env.sample πŸ› fix max file size for tests Sep 10, 2019
.gitignore ✨ add status API Aug 22, 2019
CODE_OF_CONDUCT.md πŸŽ‰ Oh boy, here we go. Oct 3, 2018
LICENSE πŸŽ‰ Oh boy, here we go. Oct 3, 2018
Makefile 🌐 add .po file with more strings Aug 7, 2019
Pipfile ⬆️ add shutilwhich to dependencies Sep 30, 2019
Pipfile.lock ⬆️ add shutilwhich to dependencies Sep 30, 2019
README.md πŸ“ add docs on the curated posts jobs Oct 10, 2019
docker-compose.override.yml.dist Add .dist file for docker environment overrides Jun 1, 2019
docker-compose.yml Default character set to `utf8` and collation to `utf8_unicode_ci` Sep 1, 2019
manage.py πŸŽ‰ Oh boy, here we go. Oct 3, 2018
requirements.txt ⬆️ add shutilwhich to dependencies Sep 30, 2019

README.md

Okuna logo

CircleCI Maintainability Test Coverage gitmoji badge

The API server for Okuna.

Table of contents

Requirements

Project overview

The project is a Django application.

Contributing

There are many different ways to contribute to the website development, just find the one that best fits with your skills and open an issue/pull request in the repository.

Examples of contributions we love include:

  • Code patches
  • Bug reports
  • Patch reviews
  • Translations
  • UI enhancements

Code of Conduct

Please read and follow our Code of Conduct.

License

Every contribution accepted is licensed under AGPL v3.0 or any later version. You must be careful to not include any code that can not be licensed under this license.

Please read carefully our license and ask us if you have any questions.

Responsible disclosure

Cyber-hero? Check out our Vulnerability Disclosure page.

Other issues

We're available almost 24/7 in the Okuna slack channel. Join us!

Git commit message conventions

Help us keep the repository history consistent πŸ™!

We use gitmoji as our git message convention.

If you're using git in your command line, you can download the handy tool gitmoji-cli.

Getting started

Clone the repository

git clone git@github.com:OkunaOrg/okuna-api.git

Create and configure your .env file

cp .env.sample .env
nano .env

Install the dependencies

pipenv install

Activate the pipenv environment

pipenv shell

Run the database migrations

python manage.py migrate

Collect the media fixtures

python manage.py collectmedia

Load the fixtures

python manage.py loaddata circles.json emoji-groups.json emojis.json badges.json categories.json languages.json

Serve with hot reload

For local API development it suffices to bind the server to localhost:

python manage.py runserver

For app development you have to bind the server to your local network:

python manage.py runserver 0.0.0.0:8000

Spawn an rq-worker

We use rq-workers to process media, deliver push notifications and more.

python manage.py rqworker

Spawn an rq-scheduler

We use rq-schedulers to run one time or repetitive tasks like cleaning up failed to upload posts.

python manage.py rqscheduler

To schedule a job, go to the /admin/scheduler route.

The available jobs are

openbook_posts.jobs.flush_draft_posts

Cleans up all draft posts which have not being modified for a day.

Should be run every hour or so.

openbook_posts.jobs.curate_top_posts

Curates the top posts, which end up in the explore tab.

Should be run every 5 minutes or so.

openbook_posts.jobs.clean_top_posts

Cleans the top posts which should no longer be top posts.

This happens if an item is soft deleted, reported and approved

Should be run every 5 minutes or so.


Django Translations

  1. Use ./manage.py makemessages -l es to generate messages. Doesn't matter which language we target, the translation tool is agnostic.
  2. This generates a new django.po file in the locale/es/LC_MESSAGES/ folder. It will have all the source strings and a place to enter the translation strings. It doesnt overwrite previous translations.
  3. Sometimes, if django is confused, it marks a string as fuzzy. So do search for the word 'fuzzy' in django.po
  4. If you find a fuzzy string, you can resolve it manually. Finally each string should like this
#: openbook_lists/validators.py:10   <- place where the string occurs in code
msgid "The list does not exist."     <- english translations  
msgstr "Die Liste ist nicht vorhanden."   <-- this will be empty for new strings
  1. Upload this django.po file to https://crowdin.com/project/okuna/settings#files by pressing Update next to the existing django.po file.
  2. Once all language volunteers have translated the new strings, download all the django.po files for each locale and put them in their respective folders.
  3. Run ./manage.py compilemessages to auto-generate django.mo files.
  4. You need to checkin both django.po and django.mo files for each locale.

Django Custom Commands

manage.py create_invite

Creates a user invite and outputs its token. Required for creating a new account.

usage: manage.py create_invite [-h] [--email EMAIL] [--username USERNAME] [--name NAME] [--badge BADGE]

manage.py import_invites

Imports user invites from a kickstarter/indiegogo csv

usage: manage.py import_invites [-h] [--indiegogo PATH_TO_CSV] [--kickstarter PATH_TO_CSV]

manage.py send_invites

Send invite emails to all user invites who have not been sent the email.

usage: manage.py send_invites [-h]

manage.py allocate_invites

Assign user invites to all or specific users.

usage: manage.py allocate_invites [-h] [--count INCREMENT_INVITES_BY_COUNT] [--total TOTAL_INVITE_COUNT_TO_SET] [--username USERNAME]

manage.py create_post_media_thumbnails

Creates media_thumbnail, media_height and media_width for items which don't have it using the Post -> PostMedia relationship.

The command was created as a one off migration tool.

usage: manage.py create_post_media_thumbnails

manage.py migrate_post_images

Migrates Post -> PostImage to Post -> PostMedia -> PostImage.

The command was created as a one off migration tool.

manage.py import_proxy_blacklisted_domains

Import a list of domains to be blacklisted when calling the ProxyAuth and ProxyDomainCheck APIs.

usage: manage.py import_proxy_blacklisted_domains [--file The path to the file with the domains to import]

Example

python manage.py import_proxy_blacklisted_domains --file ./openbook_common/misc/domain_blacklists/porn/domains

manage.py flush_proxy_blacklisted_domains

Flush all of the blacklisted proxy domains

usage: manage.py flush_proxy_blacklisted_domains

Crowdin translations update

Download the latest django.po files in the respective locale/ folders from crowdin. Then locally run all or some of these commands depending on which models need updating. It will update the .json files, then check them in.

./manage.py shell < openbook_common/i18n/update_translations_emoji_groups.py
./manage.py shell < openbook_common/i18n/update_translations_emojis.py
./manage.py shell < openbook_moderation/i18n/update_translations.py
./manage.py shell < openbook_categories/i18n/update_translations.py

Docker Compose

Replace .env settings

# Relational Database Service configuration
RDS_DB_NAME=okuna
RDS_USERNAME=root
RDS_PASSWORD=okuna
RDS_HOSTNAME=db.okuna
RDS_PORT=3306
RDS_HOSTNAME_READER=db.okuna
RDS_HOSTNAME_WRITER=db.okuna

Build the container

usage: docker-compose build

Run the container

usage: docker-compose up (-d in background)

Visit the static webserver IP

http://172.16.16.1:80

Overrides

Copy docker-compose.override.yml.dist to docker-compose.override.yml to override any settings. By default it will override the network information and fallback to localhost:80/443/3306. Docker-Compose YML Reference

Troubleshooting

macOS

The pipenv install command fails

You probably installed openssl via Homebew, make sure to follow the instructions that are given when you type brew info openssl.

FAQ

Double logging in console

The local development server runs a separate process for the auto-reloader. You can turn off the auto-reload process by passing the --noreload flag.

python manage.py runserver --noreload

Happy coding πŸŽ‰!

You can’t perform that action at this time.