https://github.com/jimbobbennett/circuitpython_parse

UrlParse library for CircuitPython
https://github.com/jimbobbennett/circuitpython_parse

circuitpython

Last synced: 5 days ago
JSON representation

UrlParse library for CircuitPython

• Host: GitHub
• URL: https://github.com/jimbobbennett/circuitpython_parse
• Owner: jimbobbennett
• License: other
• Created: 2020-04-02T04:23:15.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-07T17:25:02.000Z (about 4 years ago)
• Last Synced: 2024-12-13T14:40:17.225Z (10 days ago)
• Topics: circuitpython
• Language: Python
• Size: 129 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/circuitpython-circuitpython-parse/badge/?version=latest

    :target: https://circuitpython.readthedocs.io/projects/parse/en/latest/

    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/jimbobbennett/CircuitPython_Parse/workflows/Build%20CI/badge.svg

    :target: https://github.com/jimbobbennett/Circuitpython_CircuitPython_Parse/actions

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

Parse (absolute and relative) URLs.

This code is taken from the `CPython Parse library `_, and tweaked to work under CircuitPython.

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver 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 `_. To install for current user:

.. code-block:: shell

    pip3 install circuitpython-parse

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

.. code-block:: shell

    sudo pip3 install circuitpython-parse

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 circuitpython-parse

Usage Example

=============

Parse a URL.

.. code-block:: python

    url = "https://docs.microsoft.com/Learn?WT.mc_id=academic-0000-jabenn"

    scheme, netloc, path, params, query, fragment = parse.urlparse(url)

    print("Scheme", scheme)

    print("Netloc", netloc)

    print("Path", path)

    print("Params", params)

    print("Query", query)

    print("Fragment", fragment)

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.

Documentation

=============

For information on building library documentation, please check out `this guide `_.