adafruit-circuitpython-wsgi


Nameadafruit-circuitpython-wsgi JSON
Version 1.1.1 PyPI version JSON
download
home_pagehttps://github.com/adafruit/Adafruit_CircuitPython_WSGI
SummaryCircuitPython framework for creating WSGI compatible web server applications.
upload_time2020-07-09 19:33:41
maintainer
docs_urlNone
authorAdafruit Industries
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython wsgi web server webserver app webapp framework http https flask
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-wsgi/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/wsgi/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://adafru.it/discord
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_WSGI/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_WSGI/actions
    :alt: Build Status

CircuitPython framework for creating WSGI compatible web server applications.


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
   as a standard element. Stay tuned for PyPI availability!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-wsgi/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-wsgi

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-wsgi

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .env
    source .env/bin/activate
    pip3 install adafruit-circuitpython-wsgi


Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_WSGI/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Sphinx documentation
-----------------------

Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):

.. code-block:: shell

    python3 -m venv .env
    source .env/bin/activate
    pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

.. code-block:: shell

    cd docs
    sphinx-build -E -W -b html . _build/html

This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/adafruit/Adafruit_CircuitPython_WSGI",
    "name": "adafruit-circuitpython-wsgi",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit blinka circuitpython micropython wsgi web server webserver app webapp framework http https flask",
    "author": "Adafruit Industries",
    "author_email": "circuitpython@adafruit.com",
    "download_url": "https://files.pythonhosted.org/packages/40/bc/82c2654999cfe1abd36ee130d8b0c4abe7afc378cab1e05a72db094a9333/adafruit-circuitpython-wsgi-1.1.1.tar.gz",
    "platform": "",
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-wsgi/badge/?version=latest\n    :target: https://circuitpython.readthedocs.io/projects/wsgi/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_WSGI/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_WSGI/actions\n    :alt: Build Status\n\nCircuitPython framework for creating WSGI compatible web server applications.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\n.. note:: This library is not available on PyPI yet. Install documentation is included\n   as a standard element. Stay tuned for PyPI availability!\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-wsgi/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-wsgi\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-wsgi\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name && cd project-name\n    python3 -m venv .env\n    source .env/bin/activate\n    pip3 install adafruit-circuitpython-wsgi\n\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_WSGI/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nSphinx documentation\n-----------------------\n\nSphinx is used to build the documentation based on rST files and comments in the code. First,\ninstall dependencies (feel free to reuse the virtual environment from above):\n\n.. code-block:: shell\n\n    python3 -m venv .env\n    source .env/bin/activate\n    pip install Sphinx sphinx-rtd-theme\n\nNow, once you have the virtual environment activated:\n\n.. code-block:: shell\n\n    cd docs\n    sphinx-build -E -W -b html . _build/html\n\nThis will output the documentation to ``docs/_build/html``. Open the index.html in your browser to\nview them. It will also (due to -W) error out on any warning like Travis will. This is a good way to\nlocally verify it will pass.",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython framework for creating WSGI compatible web server applications.",
    "version": "1.1.1",
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "wsgi",
        "web",
        "server",
        "webserver",
        "app",
        "webapp",
        "framework",
        "http",
        "https",
        "flask"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a2a2de37f5aa6956309e84e42ef365a5",
                "sha256": "e3cd762df2b8f16ba02f95e5103b12667c317eee9338cc8f3a33bc9f0c395237"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-wsgi-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a2a2de37f5aa6956309e84e42ef365a5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 21720,
            "upload_time": "2020-07-09T19:33:41",
            "upload_time_iso_8601": "2020-07-09T19:33:41.291143Z",
            "url": "https://files.pythonhosted.org/packages/40/bc/82c2654999cfe1abd36ee130d8b0c4abe7afc378cab1e05a72db094a9333/adafruit-circuitpython-wsgi-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-07-09 19:33:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "adafruit",
    "error": "Could not fetch GitHub repository",
    "lcname": "adafruit-circuitpython-wsgi"
}
        
Elapsed time: 0.12160s