semvec/pypi-packages huggingface dataset:
fcs-simple-endpoint 1.0.4
"FCS SRU Simple Endpoint"
License: MIT
Requires Python: >=3.8
Keywords: SRU,FCS,CLARIN

FCS Simple Endpoint
===================

<!-- START: BADGES -->
[![](https://img.shields.io/badge/%20code%20style-black-000000)](https://github.com/psf/black)
[![](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/)
[![](https://img.shields.io/badge/linting-flake8-yellowgreen)](https://github.com/PyCQA/flake8)  
[![](https://img.shields.io/badge/%20doc%20style-sphinx-0a507a.svg)](https://www.sphinx-doc.org/en/master/usage/index.html)
[![](https://img.shields.io/badge/%20doc%20style-google-3666d6.svg)](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings)  
[![fcs-simple-endpoint @ PyPI](https://img.shields.io/pypi/v/fcs-simple-endpoint)](https://pypi.python.org/pypi/fcs-simple-endpoint)
[![](https://img.shields.io/github/last-commit/Querela/fcs-simple-endpoint-python)](https://github.com/Querela/fcs-simple-endpoint-python/commits/main)
[![Documentation Status](https://readthedocs.org/projects/fcs-simple-endpoint-python/badge/?version=latest)](https://fcs-simple-endpoint-python.readthedocs.io/en/latest/?badge=latest)
<!-- END: BADGES -->

- Based on [Java](https://github.com/clarin-eric/fcs-simple-endpoint/) implementation  
  _git commit: `47d1335288d27e860564fb878463f6b467ef7216`_
- Differences:
   - a bit more pythonic (naming, interfaces, enums etc.)


## Installation

```bash
# from github/source
python3 -m pip install 'fcs-simple-endpoint @ git+https://github.com/Querela/fcs-simple-endpoint-python.git'

# (locally) built package
python3 -m pip install dist/fcs_simple_endpoint-<version>-py2.py3-none-any.whl
# or
python3 -m pip install dist/fcs-simple-endpoint-<version>.tar.gz

# for local development
python3 -m pip install -e .
```

In `setup.cfg`:
```ini
[options]
install_requires =
    fcs-simple-endpoint @ git+https://github.com/Querela/fcs-simple-endpoint-python.git
```


## Build source/binary distribution

```bash
python3 -m pip install build
python3 -m build
```


## Development

* Uses `pytest` (with coverage, clarity and randomly plugins).

```bash
python3 -m pip install -e .[test]

pytest
```

Run style checks:
```bash
# general style checks
python3 -m pip install -e .[style]

black --check .
flake8 . --show-source --statistics
isort --check --diff .
mypy .

# building the package and check metadata
python3 -m pip install -e .[build]

python3 -m build
twine check --strict dist/*

# build documentation and check links ...
python3 -m pip install -e .[docs]

sphinx-build -b html docs dist/docs
sphinx-build -b linkcheck docs dist/docs
```


## Build documentation

```bash
python3 -m pip install -r ./docs/requirements.txt
# or 
python3 -m pip install -e .[docs]

sphinx-build -b html docs dist/docs
sphinx-build -b linkcheck docs dist/docs
```


## See also

- [clarin-eric/fcs-sru-server](https://github.com/clarin-eric/fcs-sru-server/)
- [clarin-eric/fcs-simple-endpoint](https://github.com/clarin-eric/fcs-simple-endpoint/)
jupyter-helper 0.0.1.post3
A helper for jupyter(lab/notebook/console)
License: MIT
Requires Python: >=3.10
Keywords: jupyter,helper,ipython

Quickstart
----------

.. teaser-begin

A helper for jupyter(lab/notebook/console).

|python-support| |downloads| |license| |black| |openissues| |GHDiscussion|

.. teaser-end

Installation
------------

Install via pip:
  pip install jupyter-helper

Or you can use an editable install with:
  git clone https://github.com/lll9p/jupyter-helper.git
  cd  jupyter-helper
  pip install -e . --no-build-isolation


Usage
-----

to run:
  from helper import Helper
  helper = Helper(scope=globals())
  helper.set_global_values().import_libs().run_magics().done()

or
  helper.done()

.. |latest-version| image:: https://img.shields.io/pypi/v/jupyter-helper.svg
   :alt: Latest version on PyPI
   :target: https://pypi.org/project/jupyter-helper
.. |python-support| image:: https://img.shields.io/pypi/pyversions/jupyter-helper.svg
   :target: https://pypi.org/project/jupyter-helper
   :alt: Python versions
.. |downloads| image:: https://img.shields.io/pypi/dm/jupyter-helper.svg
   :alt: Monthly downloads from PyPI
   :target: https://pypi.org/project/jupyter-helper
.. |license| image:: https://img.shields.io/pypi/l/jupyter-helper.svg
   :alt: Software license
   :target: https://github.com/lll9p/jupyter-helper/blob/master/LICENSE
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Black Formatter
.. |openissues| image:: http://isitmaintained.com/badge/open/lll9p/jupyter-helper.svg
    :target: http://isitmaintained.com/project/lll9p/jupyter-helper
    :alt: Percentage of open issues
.. |GHAction| image:: https://github.com/lll9p/jupyter-helper/workflows/Python/badge.svg
    :alt: Python
.. |GHDiscussion| image:: https://shields.io/badge/GitHub-%20Discussions-green?logo=github
    :target: https://github.com/lll9p/jupyter-helper/discussions
    :alt: GitHub Discussion