fcs-simple-endpoint


Namefcs-simple-endpoint JSON
Version 1.0.4 PyPI version JSON
download
home_pagehttps://github.com/Querela/fcs-simple-endpoint-python/
Summary"FCS SRU Simple Endpoint"
upload_time2023-11-01 14:32:49
maintainer
docs_urlNone
authorErik Körner
requires_python>=3.8
licenseMIT
keywords sru fcs clarin
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            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/)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Querela/fcs-simple-endpoint-python/",
    "name": "fcs-simple-endpoint",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "SRU,FCS,CLARIN",
    "author": "Erik K\u00f6rner",
    "author_email": "\"Erik K\u00f6rner\" <koerner@saw-leipzig.de>",
    "download_url": "https://files.pythonhosted.org/packages/1b/5e/f3c8ae260a8171a1e60455831d4527b922df7107db4d1a91151e5dcc8400/fcs-simple-endpoint-1.0.4.tar.gz",
    "platform": null,
    "description": "FCS Simple Endpoint\n===================\n\n<!-- START: BADGES -->\n[![](https://img.shields.io/badge/%20code%20style-black-000000)](https://github.com/psf/black)\n[![](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/)\n[![](https://img.shields.io/badge/linting-flake8-yellowgreen)](https://github.com/PyCQA/flake8)  \n[![](https://img.shields.io/badge/%20doc%20style-sphinx-0a507a.svg)](https://www.sphinx-doc.org/en/master/usage/index.html)\n[![](https://img.shields.io/badge/%20doc%20style-google-3666d6.svg)](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings)  \n[![fcs-simple-endpoint @ PyPI](https://img.shields.io/pypi/v/fcs-simple-endpoint)](https://pypi.python.org/pypi/fcs-simple-endpoint)\n[![](https://img.shields.io/github/last-commit/Querela/fcs-simple-endpoint-python)](https://github.com/Querela/fcs-simple-endpoint-python/commits/main)\n[![Documentation Status](https://readthedocs.org/projects/fcs-simple-endpoint-python/badge/?version=latest)](https://fcs-simple-endpoint-python.readthedocs.io/en/latest/?badge=latest)\n<!-- END: BADGES -->\n\n- Based on [Java](https://github.com/clarin-eric/fcs-simple-endpoint/) implementation  \n  _git commit: `47d1335288d27e860564fb878463f6b467ef7216`_\n- Differences:\n   - a bit more pythonic (naming, interfaces, enums etc.)\n\n\n## Installation\n\n```bash\n# from github/source\npython3 -m pip install 'fcs-simple-endpoint @ git+https://github.com/Querela/fcs-simple-endpoint-python.git'\n\n# (locally) built package\npython3 -m pip install dist/fcs_simple_endpoint-<version>-py2.py3-none-any.whl\n# or\npython3 -m pip install dist/fcs-simple-endpoint-<version>.tar.gz\n\n# for local development\npython3 -m pip install -e .\n```\n\nIn `setup.cfg`:\n```ini\n[options]\ninstall_requires =\n    fcs-simple-endpoint @ git+https://github.com/Querela/fcs-simple-endpoint-python.git\n```\n\n\n## Build source/binary distribution\n\n```bash\npython3 -m pip install build\npython3 -m build\n```\n\n\n## Development\n\n* Uses `pytest` (with coverage, clarity and randomly plugins).\n\n```bash\npython3 -m pip install -e .[test]\n\npytest\n```\n\nRun style checks:\n```bash\n# general style checks\npython3 -m pip install -e .[style]\n\nblack --check .\nflake8 . --show-source --statistics\nisort --check --diff .\nmypy .\n\n# building the package and check metadata\npython3 -m pip install -e .[build]\n\npython3 -m build\ntwine check --strict dist/*\n\n# build documentation and check links ...\npython3 -m pip install -e .[docs]\n\nsphinx-build -b html docs dist/docs\nsphinx-build -b linkcheck docs dist/docs\n```\n\n\n## Build documentation\n\n```bash\npython3 -m pip install -r ./docs/requirements.txt\n# or \npython3 -m pip install -e .[docs]\n\nsphinx-build -b html docs dist/docs\nsphinx-build -b linkcheck docs dist/docs\n```\n\n\n## See also\n\n- [clarin-eric/fcs-sru-server](https://github.com/clarin-eric/fcs-sru-server/)\n- [clarin-eric/fcs-simple-endpoint](https://github.com/clarin-eric/fcs-simple-endpoint/)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "\"FCS SRU Simple Endpoint\"",
    "version": "1.0.4",
    "project_urls": {
        "Documentation": "https://fcs-simple-endpoint-python.readthedocs.io/",
        "Homepage": "https://github.com/Querela/fcs-simple-endpoint-python/",
        "Issue Tracker": "https://github.com/Querela/fcs-simple-endpoint-python/issues",
        "Source": "https://github.com/Querela/fcs-simple-endpoint-python/"
    },
    "split_keywords": [
        "sru",
        "fcs",
        "clarin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fd0e4f1bad2d696062a6f50ffe7d084a000c0e6d24171840058f84620d90391b",
                "md5": "7d2d3dfafbac3a590b4b5185c2a480ca",
                "sha256": "4f24834bdb35a6b67b1d80af9ec9908306a4554f9772521e71feba7b28033af9"
            },
            "downloads": -1,
            "filename": "fcs_simple_endpoint-1.0.4-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7d2d3dfafbac3a590b4b5185c2a480ca",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.8",
            "size": 26985,
            "upload_time": "2023-11-01T14:32:47",
            "upload_time_iso_8601": "2023-11-01T14:32:47.135389Z",
            "url": "https://files.pythonhosted.org/packages/fd/0e/4f1bad2d696062a6f50ffe7d084a000c0e6d24171840058f84620d90391b/fcs_simple_endpoint-1.0.4-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1b5ef3c8ae260a8171a1e60455831d4527b922df7107db4d1a91151e5dcc8400",
                "md5": "81faac82fbe735c1dc957fa7dacc22f2",
                "sha256": "c1817b290731e7cc4bbfdfb9521daf7c0ec1ae2e7c51b6df61896f219fd645fd"
            },
            "downloads": -1,
            "filename": "fcs-simple-endpoint-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "81faac82fbe735c1dc957fa7dacc22f2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 26183,
            "upload_time": "2023-11-01T14:32:49",
            "upload_time_iso_8601": "2023-11-01T14:32:49.076934Z",
            "url": "https://files.pythonhosted.org/packages/1b/5e/f3c8ae260a8171a1e60455831d4527b922df7107db4d1a91151e5dcc8400/fcs-simple-endpoint-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-01 14:32:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Querela",
    "github_project": "fcs-simple-endpoint-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "fcs-simple-endpoint"
}
Erik Körner
Elapsed time: 0.15692s