elife-tools
===========
Tools for using article data in Python
Supports
============
* Python >=3.5
Non-Python dependencies
=======================
* libxml2 (Ubuntu, Arch)
Install for users
=================
Install via `pip <https://pip.pypa.io/en/stable/>`_:
.. code-block:: bash
$ pip install elifetools
You might need to install libxml manually first
.. code-block:: bash
$ sudo STATIC_DEPS=true pip install lxml==3.4.1
To install the latest version directly from git
.. code-block:: bash
$ pip install git+https://github.com/elifesciences/elife-tools.git@master
or you can add it to your project's requirements.txt file
.. code-block:: bash
git+https://github.com/elifesciences/elife-tools.git@master
Install for developers
======================
Clone the git repo
Make a virtualenv (optional)
Then
.. code-block:: bash
$ python setup.py install
Example usage
=============
.. code-block:: python
>>> from elifetools import parseJATS as parser
>>> soup = parser.parse_document('tests/sample-xml/elife-kitchen-sink.xml')
>>> print(parser.doi(soup))
More code examples can be found in `tests/basic_usage_test.py`
Testing
=======
You can run the full automated test suite from the base folder with:
.. code-block:: bash
$ python -m unittest discover tests
or you can run tests with coverage:
.. code-block:: bash
$ coverage run -m unittest discover tests
and then view the coverage report:
.. code-block:: bash
$ coverage report -m
License
=========
`The MIT License <http://opensource.org/licenses/mit-license.php>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/elifesciences/elife-tools",
"name": "elifetools",
"maintainer": "eLife Sciences Publications Ltd.",
"docs_url": null,
"requires_python": "",
"maintainer_email": "tech-team@elifesciences.org",
"keywords": "",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/a3/15/ab25fd5ba40dcbc1249848eae0a00a7cc915ab61c16561045c8a95b2b1bf/elifetools-0.40.0.tar.gz",
"platform": null,
"description": "elife-tools\n===========\n\nTools for using article data in Python\n\nSupports\n============\n\n* Python >=3.5\n\nNon-Python dependencies\n=======================\n\n* libxml2 (Ubuntu, Arch)\n\nInstall for users\n=================\n\nInstall via `pip <https://pip.pypa.io/en/stable/>`_:\n\n.. code-block:: bash\n\n $ pip install elifetools\n \nYou might need to install libxml manually first\n\n.. code-block:: bash\n\n $ sudo STATIC_DEPS=true pip install lxml==3.4.1\n\nTo install the latest version directly from git\n\n.. code-block:: bash\n\n $ pip install git+https://github.com/elifesciences/elife-tools.git@master\n\nor you can add it to your project's requirements.txt file\n\n.. code-block:: bash\n\n git+https://github.com/elifesciences/elife-tools.git@master\n\n\nInstall for developers\n======================\n\nClone the git repo\n\nMake a virtualenv (optional)\n\nThen\n\n.. code-block:: bash\n\n $ python setup.py install\n\nExample usage\n=============\n\n.. code-block:: python\n\n >>> from elifetools import parseJATS as parser\n >>> soup = parser.parse_document('tests/sample-xml/elife-kitchen-sink.xml')\n >>> print(parser.doi(soup))\n\nMore code examples can be found in `tests/basic_usage_test.py`\n\n\nTesting\n=======\n\nYou can run the full automated test suite from the base folder with:\n\n.. code-block:: bash\n\n $ python -m unittest discover tests\n\nor you can run tests with coverage:\n\n.. code-block:: bash\n\n $ coverage run -m unittest discover tests\n\nand then view the coverage report:\n\n.. code-block:: bash\n\n $ coverage report -m\n\n\nLicense\n=========\n\n`The MIT License <http://opensource.org/licenses/mit-license.php>`_\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tools for using article data in Python.",
"version": "0.40.0",
"project_urls": {
"Homepage": "https://github.com/elifesciences/elife-tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "db00624e3a85c1eec3365c4f6eaa4de7ca2cdc61a9da94c12eb56c0434eb8be8",
"md5": "530a45214e06fd1ceea48b73be8aa9b6",
"sha256": "ec4a4b9d08dea6dc1b3b001a57bd01edf947f915cfa386b34d919a9821a1dd3c"
},
"downloads": -1,
"filename": "elifetools-0.40.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "530a45214e06fd1ceea48b73be8aa9b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 65919,
"upload_time": "2024-02-27T23:32:00",
"upload_time_iso_8601": "2024-02-27T23:32:00.504488Z",
"url": "https://files.pythonhosted.org/packages/db/00/624e3a85c1eec3365c4f6eaa4de7ca2cdc61a9da94c12eb56c0434eb8be8/elifetools-0.40.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a315ab25fd5ba40dcbc1249848eae0a00a7cc915ab61c16561045c8a95b2b1bf",
"md5": "9978b1d12fcc5fd66b5c022f30d18c5b",
"sha256": "75c668d05bb6d1af01fc48696044df83d630c83be77c868c9f0c3419f399e1e4"
},
"downloads": -1,
"filename": "elifetools-0.40.0.tar.gz",
"has_sig": false,
"md5_digest": "9978b1d12fcc5fd66b5c022f30d18c5b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 91886,
"upload_time": "2024-02-27T23:32:02",
"upload_time_iso_8601": "2024-02-27T23:32:02.521937Z",
"url": "https://files.pythonhosted.org/packages/a3/15/ab25fd5ba40dcbc1249848eae0a00a7cc915ab61c16561045c8a95b2b1bf/elifetools-0.40.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-27 23:32:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "elifesciences",
"github_project": "elife-tools",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"requirements": [],
"lcname": "elifetools"
}