semvec/pypi-packages huggingface dataset:
readme-page 1.0.0
A script to create a readme GitHub Page for your project.
License: MIT License

# Readme Page

A script to create a readme [GitHub Page](https://help.github.com/articles/creating-project-pages-manually) for your project. See an [example](http://fernandojunior.github.io/readme-page).

This project uses [BeautifulSoup](http://www.crummy.com/software/BeautifulSoup/), [mkdocs](http://mkdocs.github.io/mkdocs-bootstrap/) and [six](https://pythonhosted.org/six/).


## Installation & Usage

1. Run `pip install readme-page` to install the script.

2. Run `readme-page` to create your repository GitHub Page.

3. Checkout the repository page at `http://<your_github_username>.github.io/<repository_name>`

## Contributing

See [CONTRIBUTING](https://github.com/fernandojunior/readme-page/CONTRIBUTING.md).

## License

[![CC0](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)](https://creativecommons.org/licenses/by-nc-sa/4.0/)

The MIT License.

-

Copyright (c) 2016 [Fernando Felix do Nascimento Junior](https://github.com/fernandojunior/).
ubersmith 0.3.11
Client library for the Ubersmith API 2.0
License: MIT License
Keywords: ubersmith

.. image:: https://img.shields.io/travis/jasonkeene/python-ubersmith.svg?style=flat
   :target: https://travis-ci.org/jasonkeene/python-ubersmith

.. image:: https://img.shields.io/coveralls/jasonkeene/python-ubersmith.svg?style=flat
   :target: https://coveralls.io/r/jasonkeene/python-ubersmith?branch=master

.. image:: https://img.shields.io/pypi/v/ubersmith.svg?style=flat
   :target: https://pypi.python.org/pypi/ubersmith

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

::

    pip install ubersmith

Example Use
===========

First you'll need to initialize the ubersmith package with your login credentials::

    import ubersmith
    ubersmith.init('http://ubersmith/api/2.0/', 'username', 'password')

Then you can make API calls::

    from ubersmith import uber, client
    uber.method_list()
    client.get(email='g.freeman@combineresearch.com')

These modules match the methods as documented in the `Ubersmith API 2.0 docs`_.

.. _Ubersmith API 2.0 docs: https://github.com/jasonkeene/python-ubersmith/raw/master/docs/ubersmith_api_docs.pdf

Without Module State
--------------------

ubersmith.init creates and stores a request handler with your login credentials.
If for some reason you'd prefer to not have this module state then you can
instantiate the request handler manually::

    from ubersmith.api import RequestHandler
    h = RequestHandler('http://ubersmith/api/2.0/', 'username', 'password')

and then explicitly pass it into any call function::

    from ubersmith import uber, client
    uber.method_list.handler(h)()
    client.get.handler(h)(email='g.freeman@combineresearch.com')

or you can access the call function directly on the handler and the handler
will be implicitly passed into the call function for you::

    h.uber.method_list()
    h.client.get(email='g.freeman@combineresearch.com')

Raw Processing
--------------

Alternatively you can process the request directly on the handler::

    h.process_request('uber.method_list')
    h.process_request('client.get', data={'email': 'g.freeman@combineresearch.com'})

although this will bypass any validation logic and response cleaning provided
by the call function and just return the BaseResponse from ubersmith.

Development
===========

You'll need to install the development dependencies::

    pip install -r requirements-dev.txt

Running Tests
-------------

To run the tests::

    py.test

To run the tests on multiple interpreters::

    tox

To run the tests and generate a coverage report::

    bin/coverage.sh

Console
-------

To run the dev console copy over the example config file::

    cp bin/config.py.example bin/config.py

Edit it with your credentials then run the console::

    python -i bin/console.py

From here you can run commands against your dev instance::

    >>> uber.method_list()