Welcome to am4894plots’s documentation!

am4894plots

https://img.shields.io/pypi/v/am4894plots.svg https://img.shields.io/travis/andrewm4894/am4894plots.svg Documentation Status Updates Codecov

My plotting package! I got fed up spending half a day or more each time i wanted to do some new plots or charts in python.

I never really settled on any single plotting package and refuse to learn matplotlib!

So instead anytime i have a new type of plot i need to do that could be useful again to me in future, i’m going to pick whatever plotting lib does it best/easiest for me, try generalise it a bit and add it as functionality into this package.

This was also a good excuse for me to learn a bit about developing python packages and pushing them to pypi.

Use at you own peril! Feel free to open issues and all that good stuff.

Quickstart

Features

TODO

  • Keep adding tests.
  • Animation and time based playback of a timeseries.
  • Other things as they come up.
  • World domination.
  • Mindfulness (i have multiple apps but keep procrastinating).

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template. Cookiecutter is awesome and the TalkPython course on it is great.

Installation

Stable release

To install am4894plots, run this command in your terminal:

$ pip install am4894plots

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

You can either clone the public repository:

$ git clone git://github.com/andrewm4894/am4894plots

Or download the tarball:

$ curl -OJL https://github.com/andrewm4894/am4894plots/tarball/master

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

$ python setup.py install

Usage

To use am4894plots in a project:

import am4894plots

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/andrewm4894/am4894plots/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

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

  1. Fork the am4894plots repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/am4894plots.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 am4894plots
$ cd am4894plots/
$ 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 am4894plots 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, 3.7 and 3.8, and for PyPy. Check https://travis-ci.org/andrewm4894/am4894plots/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests.test_am4894plots

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

Contributors

None yet. Why not be the first?

History

0.1.0 (2019-11-14)

  • First release on PyPI.

Indices and tables