Welcome to sirara’s documentation!¶

Contents:

sirara¶

A Python package for approximate matrix factorization.

Free software: BSD 3-Clause
Documentation: https://sirara.readthedocs.io.

Features¶

TODO

Credits¶

This package was created with Cookiecutter and the nanshe-org/nanshe-cookiecutter project template.

Installation¶

Stable release¶

To install sirara, run this command in your terminal:

$ pip install sirara

This is the preferred method to install sirara, 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 sirara can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/nanshe-org/sirara

Or download the tarball:

$ curl  -OL https://github.com/nanshe-org/sirara/tarball/master

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

$ python setup.py install

Usage¶

To use sirara in a project:

import sirara

API¶

sirara package¶

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/nanshe-org/sirara/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¶

sirara could always use more documentation, whether as part of the official sirara 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/nanshe-org/sirara/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 sirara for local development.

Fork the sirara repo on GitHub.

Clone your fork locally:

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

Install your local copy into an environment. Assuming you have conda installed, this is how you set up your fork for local development (on Windows drop source). Replace “<some version>” with the Python version used for testing.:
```
$ conda create -n siraraenv python="<some version>"
$ source activate siraraenv
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions:
```
$ flake8 sirara tests
$ python setup.py test or py.test
```
To get flake8, just conda install it into your environment.

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

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

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

The pull request should include tests.
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.
The pull request should work for Python 2.7, 3.4 and 3.5. Check https://travis-ci.org/nanshe-org/sirara/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_sirara