Welcome to cybuffer’s documentation!

Contents:

cybuffer

PyPI conda-forge Travis CI AppVeyor Read the Docs Coveralls License

A Python 2/3 compatible buffer in Cython

Features

  • TODO

Credits

This package was created with Cookiecutter and the dask-image/dask-image-cookiecutter project template.

Installation

Stable release

To install cybuffer, run this command in your terminal:

$ pip install cybuffer

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

You can either clone the public repository:

$ git clone git://github.com/jakirkham/cybuffer

Or download the tarball:

$ curl  -OL https://github.com/jakirkham/cybuffer/tarball/master

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

$ python setup.py install

Usage

To use cybuffer in a project:

import cybuffer

API

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/jakirkham/cybuffer/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

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

  1. Fork the cybuffer repo on GitHub.

  2. Clone your fork locally:

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

  3. 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 cybufferenv python="<some version>"
$ source activate cybufferenv
$ 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:

    $ flake8 cybuffer tests
$ python setup.py test or py.test

    To get flake8, just conda install it into your environment.

  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. Check https://travis-ci.org/jakirkham/cybuffer/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_cybuffer.py

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.0 (2018-11-13)

  • First release on PyPI.

Indices and tables