Welcome to wcraas_control’s documentation!

wcraas_control

WCraaS Storage Service

• Free software: MIT license
• Documentation: https://wcraas-control.readthedocs.io.

Features

• TODO

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install wcraas_control, run this command in your terminal:

$ pip install wcraas_control

This is the preferred method to install wcraas_control, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for wcraas_control can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/WCraaS/wcraas_control

Or download the tarball:

$ curl -OJL https://github.com/WCraaS/wcraas_control/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use wcraas_control in a project:

import wcraas_control

wcraas_control

wcraas_control package

Submodules

wcraas_control.cli module

Console script for wcraas_control.

wcraas_control.config module

class wcraas_control.config.Config

Bases: wcraas_control.config.Config

classmethod fromenv()

Create a wcraas_control.Config from Environment Variables.

>>> conf = Config.fromenv()
>>> type(conf)
<class 'config.Config'>
>>> conf._fields
('amqp', 'redis', 'interval', 'loglevel')
>>> conf.amqp
AMQPConfig(host='localhost', port=5672, user='guest', password='guest')
>>> conf.redis
RedisConfig(host='localhost', port=6379)
>>> conf.interval
10
>>> conf.loglevel
20

class wcraas_control.config.RedisConfig

Bases: wcraas_control.config.RedisConfig

classmethod fromenv()

Create a wcraas_control.RedisConfig from Environment Variables.

>>> conf = RedisConfig.fromenv()
>>> type(conf)
<class 'config.RedisConfig'>
>>> conf._fields
('host', 'port')
>>> conf.host
'localhost'
>>> conf.port
6379

wcraas_control.wcraas_control module

The WCraaS Control module is responsible for the orchestration of tasks in the platform.

class wcraas_control.wcraas_control.RedisLockState

Bases: enum.IntEnum

An enumeration.

DONE = 2

FAIL = 3

FREE = 0

LOCK = 1

class wcraas_control.wcraas_control.ControlWorker(amqp: wcraas_common.config.AMQPConfig, redis: wcraas_control.config.RedisConfig, interval: int, loglevel: int, *args, **kwargs)

Bases: wcraas_common.wcraas_common.WcraasWorker

Control Worker for the WCraaS platfrom, responsible for the orchestration of tasks.

>>> from wcraas_control.config import Config
>>> cn = ControlWorker(*Config.fromenv())

crawl(url: str)

Given URL orchestrate crawling of the target.

Parameters:url (string) – Entrypoint URL for crawling the target.

list_collections()

List the collections available at the storage node.

start()

Asynchronous runtime for the worker, responsible of managing and maintaining async context open.

Module contents

Top-level package for wcraas_control.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/WCraaS/wcraas_control/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

control could always use more documentation, whether as part of the official control docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/WCraaS/wcraas_control/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up wcraas_control for local development.

1. Fork the wcraas_control repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/wcraas_control.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv wcraas_control
   $ cd wcraas_control/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 wcraas_control tests
   $ python setup.py test or pytest
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7, 3.5, 3.6 and 3.7, and for PyPy. Check https://travis-ci.org/WCraaS/wcraas_control/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests.test_wcraas_control

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

• Kolokotronis Panagiotis <panagiks@gmail.com>

Contributors

None yet. Why not be the first?

History

0.1.2 (2019-10-28)

• BUGFIX: Avoid infinite recursion over leftover failed URLs.
• Add more detailed logging & proper loglevels.

0.1.1 (2019-10-02)

• Mark docs as stable.

0.1.0 (2019-09-21)

• First release on PyPI.

Indices and tables

• Index
• Module Index
• Search Page