Welcome to Cryptohands’s documentation!

Contents:

Cryptohands

https://img.shields.io/pypi/v/cryptohands.svg https://img.shields.io/travis/Chaffelson/cryptohands.svg Documentation Status Updates test coverage License

For making Crypto Pizza

Features

# TODO: Add some features to add

Credits

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

Installation

Stable release

To install Cryptohands, run this command in your terminal:

$ pip install cryptohands

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

You can either clone the public repository:

$ git clone git://github.com/chaffelson/cryptohands

Or download the tarball:

$ curl  -OL https://github.com/chaffelson/cryptohands/tarball/master

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

$ python setup.py install

Usage

To use Cryptohands in a project:

Rename sample_config.json to config.json and supply your credential information

You can probably find Bitfinex information at: https://www.bitfinex.com/api

You can probably figure out how to get GoogleAPI keys at: https://github.com/burnash/gspread

I strongly recommend reading the gspread guide on setting up security. You’ll need to share your sheet with the client email that the Google OAuth creates

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/chaffelson/cryptohands/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

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

  1. Fork the cryptohands repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/cryptohands.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 cryptohands
$ cd cryptohands/
$ 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 cryptohands tests
$ python setup.py test or py.test
$ 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.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/chaffelson/cryptohands/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_cryptohands

Development Notes

A collection point for information about the development process for future collaborators

Release Process

This assumes you have virtualenvwrapper, git, and appropriate python versions installed, as well as the necessary test environment:

  • update History.rst

  • update setup.py

  • check requirements.txt and requirements_dev.txt

  • Commit all changes

  • in bash:

    mktmpenv --python=python3.5
cd ProjectDir
pip install -e .[dev]
tox
# Fix issues
python setup.py build_sphinx
# check docs in build/sphinx/html/index.html
# Commit any minor changes, else retest
bumpversion patch|minor|major
# Check version has updated correctly
python setup.py sdist bdist_wheel
deactivate
mktmpenv --python=python3.5
pip install path/to/projectname-version-etc.whl  # for example
# Run appropriate tests, such as usage tests etc.
deactivate
# You may have to reactivate your original virtualenv
twine upload dist/*
# You may get a file exists error, check you're not trying to reupload an existing version
git push --follow-tags

  • check build in TravisCI

  • check docs on ReadTheDocs

  • check release published on Github and PyPi

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.0.1 (2017-09-10)

  • First release
  • No Anchovy

Indices and tables