<commit_before>NOTE!
=====
This is still work in progress and parts of the API might change as I test it further.

Welcome to pyfilemail's documentation!
======================================

Pyfilemail is a command line tool and API for sending and recieving files with `Filemail <https://www.filemail.com>`_
based on `requests <https://github.com/kennethreitz/requests>`_ and filemail's `API <https://www.filemail.com/apidoc/ApiDocumentation.aspx>`_.

To avoid nagging about API KEY you should register and get one `here <http://www.filemail.com/apidoc/ApiKey.aspx>`_.
If you register for a paid plan you unlock all features and will be able to add/delete/update your transfers/contacts/group/company settings.
Without registering you'll still be able to send files as a free plan user but remember to use the ``--free`` argument in the command line tool.

For more info on the different plans please go to `Filemail <https://www.filemail.com>`_

I've tried to keep this api as simple as possible and rely on filemail's own validation of data to keep you all in check :)
The reason for this is that I don't work at filemail and have no insight in what validation they have for the data passed.
It also saves me a lot of head ache writing rock solid validation code and I think this is a more flexible way of doing it if the Filemail team decides to change
the API in any way.

Appart from ``pyfilemail.User`` and  ``pyfilemail.Transfer`` classes, all return objects from filemail are ``dict`` objects based on json responses.

So far this has been developed and tested on Ubuntu 16.04.
I'll try to get my hands on a Windows and OSX machine and addapt the code to make sure it works there as well.

API documentation is available at `readthedocs <http://pyfilemail.readthedocs.io/en/latest/>`_

Any feedback is more than welcome and please report bugs through `github <https://github.com/apetrynet/pyfilemail/issues>`_

Installation
============

..  code-block:: bash

    pip install pyfilemail

Command line example
====================

..  code-block:: bash

    pyfilemail \
    --from <EMAIL> \
    --to <EMAIL> \<commit_msg>added info on pip search bug<commit_after>NOTE!
=====
This is still work in progress and parts of the API might change as I test it further.

Welcome to pyfilemail's documentation!
======================================

Pyfilemail is a command line tool and API for sending and recieving files with `Filemail <https://www.filemail.com>`_
based on `requests <https://github.com/kennethreitz/requests>`_ and filemail's `API <https://www.filemail.com/apidoc/ApiDocumentation.aspx>`_.

To avoid nagging about API KEY you should register and get one `here <http://www.filemail.com/apidoc/ApiKey.aspx>`_.
If you register for a paid plan you unlock all features and will be able to add/delete/update your transfers/contacts/group/company settings.
Without registering you'll still be able to send files as a free plan user but remember to use the ``--free`` argument in the command line tool.

For more info on the different plans please go to `Filemail <https://www.filemail.com>`_

I've tried to keep this api as simple as possible and rely on filemail's own validation of data to keep you all in check :)
The reason for this is that I don't work at filemail and have no insight in what validation they have for the data passed.
It also saves me a lot of head ache writing rock solid validation code and I think this is a more flexible way of doing it if the Filemail team decides to change
the API in any way.

Appart from ``pyfilemail.User`` and  ``pyfilemail.Transfer`` classes, all return objects from filemail are ``dict`` objects based on json responses.

So far this has been developed and tested on Ubuntu 16.04.
I'll try to get my hands on a Windows and OSX machine and addapt the code to make sure it works there as well.

API documentation is available at `readthedocs <http://pyfilemail.readthedocs.io/en/latest/>`_

Any feedback is more than welcome and please report bugs through `github <https://github.com/apetrynet/pyfilemail/issues>`_

Installation
============
There seems to be an issue with new packages in `pypi <https://bitbucket.org/pypa/pypi/issues/326/some-packages-not-showing-up-when>`_ that prevents ``pip search pyfilemail`` to function, but the install command below works.

..  code-block:: bash

    pip install pyfilemail

Command line example
====================

..  code-block:: bash

    pyfilemail \
    --from <EMAIL> \
    --to <EMAIL> \
{'fraction_non_alphanumeric': 0.10376940133037695, 'fraction_numerical': 0.0024390243902439024, 'mean_word_length': 4.215028901734104, 'pattern_counts': {'":': 0, '<': 22, '<?xml version=': 0, '>': 22, 'https://': 11, 'lorem ipsum': 0, 'www.': 8, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '588594', 'n_tokens_mistral': 1282, 'n_tokens_neox': 1198, 'n_words': 618}