Metadata-Version: 2.1
Name: pyswot
Version: 0.2.0
Summary: Python wrapper for JetBrains/swot.
Home-page: https://github.com/diagnijmegen/rse-pyswot
Author: James Meakin
Author-email: code@jmsmkn.com
License: Apache Software License 2.0
Keywords: pyswot
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.6
License-File: LICENSE
License-File: AUTHORS.rst

======
PySwot
======

.. image:: https://img.shields.io/pypi/v/pyswot.svg
        :target: https://pypi.python.org/pypi/pyswot

.. image:: https://github.com/DIAGNijmegen/rse-pyswot/workflows/CI/badge.svg
   :target: https://github.com/DIAGNijmegen/rse-pyswot/actions?query=workflow%3ACI+branch%3Amaster
   :alt: Build Status

.. image:: https://codecov.io/gh/DIAGNijmegen/rse-pyswot/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/DIAGNijmegen/rse-pyswot
   :alt: Code Coverage Status

Python wrapper for `JetBrains/swot`_.

* Free software: Apache Software License 2.0
* Documentation: https://pyswot.readthedocs.io.


Features
--------

This library is a wrapper around `JetBrains/swot`_ and provides two methods:

.. code-block:: python

    >>> from pyswot import is_academic
    >>> is_academic("user@ox.ac.uk")
    True
    >>> is_academic("user@gmail.com")
    False

.. code-block:: python

    >>> from pyswot import find_school_names
    >>> find_school_names("user@ox.ac.uk")
    ['University of Oxford']
    >>> find_school_names("user@gmail.com")
    []

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _`JetBrains/swot`: https://github.com/JetBrains/swot
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.2.0 (2022-02-15)
------------------

* Dropped support for Python 3.6
* Added support for Python 3.10
* ``find_school_names`` now returns ``None`` if the source school name could not be utf-8 decoded
* Reduced the number of files in deployment by vendoring the sources

0.1.3 (2021-03-02)
------------------

* Updates domain sources
* Adds tests on Python 3.9

0.1.2 (2020-09-26)
------------------

* Fixes missing files and non-utf8 institution names

0.1.0 (2020-09-25)
------------------

* First release on PyPI.


