https://github.com/maxtepkeev/instructions
Working with Python iterable data structures made easy
https://github.com/maxtepkeev/instructions
Last synced: 4 months ago
JSON representation
Working with Python iterable data structures made easy
- Host: GitHub
- URL: https://github.com/maxtepkeev/instructions
- Owner: maxtepkeev
- License: other
- Created: 2015-02-24T13:57:02.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-01-13T12:56:46.000Z (over 7 years ago)
- Last Synced: 2025-04-19T00:04:32.797Z (about 1 year ago)
- Language: Python
- Size: 101 KB
- Stars: 14
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
Instructions
============
.. image:: https://badge.fury.io/py/instructions.svg
:target: https://badge.fury.io/py/instructions
.. image:: https://img.shields.io/travis/maxtepkeev/instructions/master.svg
:target: https://travis-ci.org/maxtepkeev/instructions
.. image:: https://img.shields.io/coveralls/maxtepkeev/instructions/master.svg
:target: https://coveralls.io/r/maxtepkeev/instructions?branch=master
All developers are doing the same thing everyday - they're searching for some values inside
iterable data structures, trying to filter them somehow or count elements inside which satisfy
some requirements. We keep writing the same code over and over again from project to project.
There's no more need to do this, Instructions to the rescue. Instructions is a library, written
in Python to simplify lives of Python developers. This is how we could write some code using
Instructions which searches for a string with a length of 3 inside a list of values:
.. code-block:: python
>>> instructions.findstring__len(3).inside(['foo', 'bar', 'blah', 1, 2])
Instructions does all the hard work for you, just tell it what do you want to do in plain english
and it will magically execute your instruction.
Features
--------
* Supports Python 2.6 - 3.6, PyPy and PyPy3
* Supports all built-in Python data types
* Easily extendable
* Extensively documented
* Comes with more than 100 filters
Installation
------------
To install Instructions, simply:
.. code-block:: bash
$ pip install instructions
or:
.. code-block:: bash
$ easy_install instructions
Documentation
-------------
Documentation is available at https://instructions.readthedocs.io.
Contacts and Support
--------------------
I will be glad to get your `feedback `_, `pull requests
`_, `issues `_,
whatever. Feel free to contact me for any questions.
Donations and Sponsorship
-------------------------
If you like this project and want to support it you have several options:
#. Just give this project a star at the top of the page.
#. Become a sponsor. Contact me via ``tepkeev at gmail dot com`` if you are interested in becoming a sponsor
and we will discuss the terms and conditions.
Copyright and License
---------------------
Instructions is licensed under Apache 2.0 license. Check the `LICENSE
`_ for details.