:mod:`api` -- Rewards Suite API package *************************************** .. automodule:: api :members: :undoc-members: :show-inheritance: :mod:`api.serializers` -- Rewards Suite API serializers ------------------------------------------------------- .. automodule:: api.serializers :members: :undoc-members: :show-inheritance: :mod:`api.urls` -- Rewards Suite API URL configuration module ------------------------------------------------------------- .. automodule:: api.urls :members: :undoc-members: :show-inheritance: :mod:`api.views` -- Rewards Suite API views module -------------------------------------------------- .. automodule:: api.views :members: :undoc-members: :show-inheritance: :mod:`contract` -- Rewards Suite smart contract package ******************************************************* .. automodule:: contract :members: :undoc-members: :show-inheritance: :mod:`contract.artifacts` -- Smart contract artifacts ----------------------------------------------------- .. automodule:: contract.artifacts :members: :undoc-members: :show-inheritance: :mod:`contract.contract` -- Smart contract creation module ---------------------------------------------------------- .. automodule:: contract.contract :members: :undoc-members: :show-inheritance: :mod:`contract.deploy` -- Module with functions for smart contract deployment ----------------------------------------------------------------------------- .. automodule:: contract.deploy :members: :undoc-members: :show-inheritance: :mod:`contract.helpers` -- Smart contract helper functions module ----------------------------------------------------------------- .. automodule:: contract.helpers :members: :undoc-members: :show-inheritance: :mod:`contract.network` -- Module for functions to communicate with blockchain ------------------------------------------------------------------------------ .. automodule:: contract.network :members: :undoc-members: :show-inheritance: :mod:`contract.tests` -- Smart contract unit-tests package ---------------------------------------------------------- .. automodule:: contract.tests :members: :undoc-members: :show-inheritance: :mod:`core` -- Main application package *************************************** .. automodule:: core :members: :undoc-members: :show-inheritance: :mod:`core.admin` -- Main application administration module ----------------------------------------------------------- .. automodule:: core.admin :members: :undoc-members: :show-inheritance: :mod:`core.apps` -- Main application configuration module --------------------------------------------------------- .. automodule:: core.apps :members: :undoc-members: :show-inheritance: :mod:`core.forms` -- Module with main application's forms --------------------------------------------------------- .. automodule:: core.forms :members: :undoc-members: :show-inheritance: :mod:`core.models` -- Main application ORM module ------------------------------------------------- .. automodule:: core.models :members: :undoc-members: :show-inheritance: :mod:`core.signals` -- Module with main application's database signals and triggers ----------------------------------------------------------------------------------- .. automodule:: core.signals :members: :undoc-members: :show-inheritance: :mod:`core.urls` -- Main application URL configuration module ------------------------------------------------------------- .. automodule:: core.urls :members: :undoc-members: :show-inheritance: :mod:`core.views` -- Main application views (controllers) --------------------------------------------------------- .. automodule:: core.views :members: :undoc-members: :show-inheritance: :mod:`core.management` -- Project's management commands package --------------------------------------------------------------- .. automodule:: core.management :members: :undoc-members: :show-inheritance: :mod:`core.migrations` -- Main application database migrations package ---------------------------------------------------------------------- .. automodule:: core.migrations :members: :undoc-members: :show-inheritance: :mod:`core.static` -- Directory holding main application static files --------------------------------------------------------------------- .. automodule:: core.static :members: :undoc-members: :show-inheritance: :mod:`core.static.css` -- Directory holding main application CSS files ---------------------------------------------------------------------- .. automodule:: core.static.css :members: :undoc-members: :show-inheritance: :mod:`core.templates` -- Directory holding main application Django template files --------------------------------------------------------------------------------- .. automodule:: core.templates :members: :undoc-members: :show-inheritance: :mod:`core.tests` -- Main application unit-tests package -------------------------------------------------------- .. automodule:: core.tests :members: :undoc-members: :show-inheritance: :mod:`issues` -- Package with various issue tracker providers implementation **************************************************************************** .. automodule:: issues :members: :undoc-members: :show-inheritance: :mod:`issues.base` -- Module with base classes for issues and webhooks processing --------------------------------------------------------------------------------- .. automodule:: issues.base :members: :undoc-members: :show-inheritance: :mod:`issues.bitbucket` -- Module with classes and functions dealing with Bitbucket issues and webhooks ------------------------------------------------------------------------------------------------------- .. automodule:: issues.bitbucket :members: :undoc-members: :show-inheritance: :mod:`issues.config` -- Module for issue providers confirguration from environment variables -------------------------------------------------------------------------------------------- .. automodule:: issues.config :members: :undoc-members: :show-inheritance: :mod:`issues.github` -- Module with classes and functions dealing with GitHub issues and webhooks ------------------------------------------------------------------------------------------------- .. automodule:: issues.github :members: :undoc-members: :show-inheritance: :mod:`issues.gitlab` -- Module with classes and functions dealing with GitLab issues and webhooks ------------------------------------------------------------------------------------------------- .. automodule:: issues.gitlab :members: :undoc-members: :show-inheritance: :mod:`issues.main` -- Main issue tracker class and public functions ------------------------------------------------------------------- .. automodule:: issues.main :members: :undoc-members: :show-inheritance: :mod:`issues.tests` -- Unit-tests package for the issue trackers package ------------------------------------------------------------------------ .. automodule:: issues.tests :members: :undoc-members: :show-inheritance: :mod:`manage` -- Django main module *********************************** .. automodule:: manage :members: :undoc-members: :show-inheritance: :mod:`rewards` -- Frontend application to the Rewards smart contract ******************************************************************** .. automodule:: rewards :members: :undoc-members: :show-inheritance: :mod:`rewards.apps` -- Configuration module for the smart contract frontend application --------------------------------------------------------------------------------------- .. automodule:: rewards.apps :members: :undoc-members: :show-inheritance: :mod:`rewards.urls` -- Smart contract frontend application URL configuration module ----------------------------------------------------------------------------------- .. automodule:: rewards.urls :members: :undoc-members: :show-inheritance: :mod:`rewards.templates` -- Directory holding Smart contract frontend applicatio Django template files ------------------------------------------------------------------------------------------------------ .. automodule:: rewards.templates :members: :undoc-members: :show-inheritance: :mod:`rewards.views` -- Smart contract frontend application views ----------------------------------------------------------------- .. automodule:: rewards.views :members: :undoc-members: :show-inheritance: :mod:`rewards.tests` -- Smart contract frontend application unit-tests package ------------------------------------------------------------------------------ .. automodule:: rewards.tests :members: :undoc-members: :show-inheritance: :mod:`rewardsweb` -- Main configuration package *********************************************** .. automodule:: rewardsweb :members: :undoc-members: :show-inheritance: :mod:`rewardsweb.settings` -- Project's settings package -------------------------------------------------------- .. automodule:: rewardsweb.settings :members: :undoc-members: :show-inheritance: :mod:`rewardsweb.settings.base` -- Base project's settings for all infrastructures ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: rewardsweb.settings.base :members: :undoc-members: :show-inheritance: :mod:`rewardsweb.settings.development` -- Project's settings for development infrastructure ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: rewardsweb.settings.development :members: :undoc-members: :show-inheritance: :mod:`rewardsweb.settings.production` -- Project's settings for production infrastructure ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: rewardsweb.settings.production :members: :undoc-members: :show-inheritance: :show-inheritance: :mod:`rewardsweb.tests` -- Project's unit-tests package ------------------------------------------------------- .. automodule:: rewardsweb.tests :members: :undoc-members: :show-inheritance: :mod:`rewardsweb.asgi` -- Module containing asynchronous application -------------------------------------------------------------------- .. automodule:: rewardsweb.asgi :members: :undoc-members: :show-inheritance: :mod:`rewardsweb.urls` -- Main website's URL configuration module ----------------------------------------------------------------- .. automodule:: rewardsweb.urls :members: :undoc-members: :show-inheritance: :mod:`rewardsweb.wsgi` -- Module containing main wsgi application ----------------------------------------------------------------- .. automodule:: rewardsweb.wsgi :members: :undoc-members: :show-inheritance: :mod:`trackers` -- Social media trackers package ************************************************ .. automodule:: trackers :members: :undoc-members: :show-inheritance: :mod:`trackers.apps` -- Trackers application configuration module ----------------------------------------------------------------- .. automodule:: trackers.apps :members: :undoc-members: :show-inheritance: :mod:`trackers.base` -- Module containing base class for all social media trackers ---------------------------------------------------------------------------------- .. automodule:: trackers.base :members: :undoc-members: :show-inheritance: :mod:`trackers.config` -- Module for trackers confirguration from environment variables --------------------------------------------------------------------------------------- .. automodule:: trackers.config :members: :undoc-members: :show-inheritance: :mod:`trackers.discord` -- Module for processing Discord comments ----------------------------------------------------------------- .. automodule:: trackers.discord :members: :undoc-members: :show-inheritance: :mod:`trackers.models` -- Trackers application ORM module ---------------------------------------------------------- .. automodule:: trackers.models :members: :undoc-members: :show-inheritance: :mod:`trackers.parser` -- Module cointaining class for parsing sociial media messages ------------------------------------------------------------------------------------- .. automodule:: trackers.parser :members: :undoc-members: :show-inheritance: :mod:`trackers.reddit` -- Module for processing Reddit comments --------------------------------------------------------------- .. automodule:: trackers.reddit :members: :undoc-members: :show-inheritance: :mod:`trackers.runners` -- Module containing trackers run functions ------------------------------------------------------------------- .. automodule:: trackers.runners :members: :undoc-members: :show-inheritance: :mod:`trackers.telegram` -- Module for processing Telegram messages ------------------------------------------------------------------- .. automodule:: trackers.telegram :members: :undoc-members: :show-inheritance: :mod:`trackers.twitter` -- Module for processing comments on X/Twitter using official API ----------------------------------------------------------------------------------------- .. automodule:: trackers.twitter :members: :undoc-members: :show-inheritance: :mod:`trackers.twitterapiio` -- Module for processing comments on X/Twitter using TwitterAPI.io ----------------------------------------------------------------------------------------------- .. automodule:: trackers.twitterapiio :members: :undoc-members: :show-inheritance: :mod:`trackers.tests` -- Unit-tests package for trackers package ---------------------------------------------------------------- .. automodule:: trackers.tests :members: :undoc-members: :show-inheritance: :mod:`updaters` -- Social media messages updating package ********************************************************* .. automodule:: updaters :members: :undoc-members: :show-inheritance: :mod:`updaters.base` -- Module containing base class for all social media updaters ---------------------------------------------------------------------------------- .. automodule:: updaters.base :members: :undoc-members: :show-inheritance: :mod:`updaters.discord` -- Module for updating Discord comments --------------------------------------------------------------- .. automodule:: updaters.discord :members: :undoc-members: :show-inheritance: :mod:`updaters.main` -- Module containing main updating class and updaters regiustry ------------------------------------------------------------------------------------ .. automodule:: updaters.main :members: :undoc-members: :show-inheritance: :mod:`updaters.reddit` -- Module for updating Reddit comments ------------------------------------------------------------- .. automodule:: updaters.reddit :members: :undoc-members: :show-inheritance: :mod:`updaters.telegram` -- Module for updating Telegram messages ----------------------------------------------------------------- .. automodule:: updaters.telegram :members: :undoc-members: :show-inheritance: :mod:`updaters.twitter` -- Module for updating comments on X/Twitter -------------------------------------------------------------------- .. automodule:: updaters.twitter :members: :undoc-members: :show-inheritance: :mod:`updaters.tests` -- Unit-tests package for updaters package ---------------------------------------------------------------- .. automodule:: updaters.tests :members: :undoc-members: :show-inheritance: :mod:`utils` -- Package with various website's utility functions and constants ****************************************************************************** .. automodule:: utils :members: :undoc-members: :show-inheritance: :mod:`utils.constants` -- Website's constants package ----------------------------------------------------- .. automodule:: utils.constants :members: :undoc-members: :show-inheritance: :mod:`utils.constants.core` -- Main application constants ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: utils.constants.core :members: :undoc-members: :show-inheritance: :mod:`utils.importers` -- Website's utility functions for importing data from the old system -------------------------------------------------------------------------------------------- .. automodule:: utils.importers :members: :undoc-members: :show-inheritance: :mod:`utils.mappers` -- Website's utility functions for mapping existing GitHub issues -------------------------------------------------------------------------------------- .. automodule:: utils.mappers :members: :undoc-members: :show-inheritance: :mod:`utils.helpers` -- Website's helper utility functions ---------------------------------------------------------- .. automodule:: utils.helpers :members: :undoc-members: :show-inheritance: :mod:`utils.tests` -- Unit tests for website's utils package ------------------------------------------------------------ .. automodule:: utils.tests :members: :undoc-members: :show-inheritance: :mod:`walletauth` -- Wallet connecting authentication application ***************************************************************** .. automodule:: walletauth :members: :undoc-members: :show-inheritance: :mod:`walletauth.apps` -- Wallet connecting authentication application configuration module ------------------------------------------------------------------------------------------- .. automodule:: walletauth.apps :members: :undoc-members: :show-inheritance: :mod:`walletauth.models` -- Wallet connecting authentication application ORM module ----------------------------------------------------------------------------------- .. automodule:: walletauth.models :members: :undoc-members: :show-inheritance: :mod:`walletauth.urls` -- Wallet connecting authentication application URL configuration module ----------------------------------------------------------------------------------------------- .. automodule:: walletauth.urls :members: :undoc-members: :show-inheritance: :mod:`walletauth.views` -- Wallet connecting authentication application views ----------------------------------------------------------------------------- .. automodule:: walletauth.views :members: :undoc-members: :show-inheritance: :mod:`walletauth.migrations` -- Wallet connecting authentication application database migrations package -------------------------------------------------------------------------------------------------------- .. automodule:: walletauth.migrations :members: :undoc-members: :show-inheritance: :mod:`walletauth.tests` -- Wallet connecting authentication application unit-tests package ------------------------------------------------------------------------------------------ .. automodule:: walletauth.tests :members: :undoc-members: :show-inheritance: