Welcome to AdSelect’s documentation!

What is AdSelect

AdSelect is one the nodes in Adshares network. Its’ role is to select ads to display for the Publisher. Banners are chosen based on previous payments and Publisher’s ad policy.

Deployment

Installation

git clone https://github.com/adshares/adselect.git

pipenv install

or

pipenv install --dev for development

Architecture

AdSelect is a Twisted app, backed by MongoDB and communicating with the network by JSON-RPC.

Python stack looks like this:

• Twisted for the core network communication and asynchronous event handling
• txmongo for asynchronous MongoDB communication
• fastjsonrpc for JSON-RPC protocol
• jsonobject for easy JSON-Python object mapping

Development

Extending functionality

All the banner selection logic happens in adselect.stats module, so if you want to change the algorithms, you’ll need to rewrite that part of the code. Some configuration is possible through the config files.

The calculations are run periodically. The main function for each run is the adselect.stats.recalculate_stats(). Calculation functions can be found in adselect.stats.utils and adselect.stats.tasks.

Packages

• How it works
  • Selection process
  • In detail
• API description
  • JSONRPC basics
    • Simple example
    • Error responses
  • API methods
    • campaign_update
    • campaign_delete
    • impression_add
    • impression_payment_add
    • banner_select
  • Protocol objects
• Reference
  • adselect package
    • adselect.contrib package
      • adselect.contrib.logs module
      • adselect.contrib.utils module
    • adselect.db package
      • adselect.db.utils module
    • adselect.iface package
      • adselect.iface.protocol module
      • adselect.iface.server module
      • adselect.iface.utils module
    • adselect.stats package
      • adselect.stats.cache module
      • adselect.stats.tasks module
      • adselect.stats.utils module
  • daemon.py
• Testing
• Configuration
  • Calculations (adselect.stats.const)
  • Database (adselect.db.const)
  • Interface (adselect.iface.const)
  • Utilities (adselect.contrib.const)
  • Logging
• Deployment
  • Getting the code
  • Requirements
    • Python
    • PIP (Python package manager)
    • Pipenv
    • Project Python dependencies
    • Additional requirements
  • Quick requirements install
  • Start the server
  • Other deployment configurations
    • Supervisord
    • Docker
• Contributing
  • Code and issues
  • Installation for development
  • Documentation
  • Tests

Indices and tables

• Index
• Module Index
• Search Page