Welcome to Tradecalc’s documentation!¶

Contents:

Tradecalc¶

CLI tool to calculate trading positions for risk management on different markets.

Free software: MIT license
Documentation: http://tradecalc.readthedocs.io/en/latest/
Source: http://github.com/toirl/tradecalc

Features¶

Calculate max position size you can buy/sell at a given price, with a limited risk.

Credits¶

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

Installation¶

Stable release¶

To install Tradecalc, run this command in your terminal:

$ pip install tradecalc

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

You can either clone the public repository:

$ git clone git://github.com/toirl/tradecalc

Or download the tarball:

$ curl  -OL https://github.com/toirl/tradecalc/tarball/master

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

$ python setup.py install

Usage¶

To calculate your maximum position 3 variables must be known:

The buy/sell price you want to buy/sell some asset.
The stop loss price. The stop loss price is the price where you close your current position to reduce losses.
Your insert. You insert is the max amount of money you will set at risk to loose in this order.

Important

Following serious risk management you should only insert 1-2% of your total credit per trade. This means to do a trade with risk of 100$ to loose you should have 100000$ total credit in the back.

Do not confuse your insert with the value of the trade. Depending on your stop loss the total value of your trade will be much higher than your insert. See example below.

Calculate position size¶

Lets say you want to place on order and can risk 100$ to loose in this order. The current order price is 150$ and you want to set the stop loss at 140$.

To calcule the maximum buy position you can invoke the command like this:

$ tradecalc buy 150 140 100
Stop Loss at price at 140.0$
Size of position 10.0 units (1500.0$)

This means you can buy 10 units of the asset with a total value of 1500$ in this trade with a risk to loose 100$ in case you set your stop loss at 140$.

To sell a position the command work the same:

$ tradecalc sell 150 160 100 --absolut-risk
Stop Loss at price at 160.0$
Size of position 10.0 units (1500.0$)

This means you can sell 10 units of the asset with a total value of 1500$ in this trade with a risk to loose 100$ in case you set your stop loss at 160$.

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/toirl/tradecalc/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¶

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

Fork the tradecalc repo on GitHub.

Clone your fork locally:

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

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv tradecalc
$ cd tradecalc/
$ 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 with tox:
```
$ flake8 tradecalc tests
$ python setup.py test or py.test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

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.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/toirl/tradecalc/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ py.test tests.test_tradecalc