# HalApyJson
## Description
A light interface to query [HAL](https://api.archives-ouvertes.fr/docs) through its API.
## Installation
Run the following to install:
```python
pip install HalApyJson
```
## Usage example
```python
import HalApyJson as haj
year = "2023"
institute = "Liten"
hal_df = haj.build_hal_df_from_api(year,institute)
hal_df.to_excel(<your_fullpath_file.xlsx>, index = False)
```
**CLI exemple**
```python
cli_hal -y 2023 -i liten
```
**for more exemples refer to** [HalApyJson-exemples](https://github.com/Bertin-fap/HalApyJson/blob/main/Demo_HalApyJson.ipynb).
# Release History
- 1.0.0 first release
- 1.1.0 added CLI
- 1.1.1 removed prints
- 1.1.2 updated CLI
- 1.1.3 refactored code after pylint scan
# Meta
- authors : BiblioAnalysis team
Distributed under the [MIT license](https://mit-license.org/)
Raw data
{
"_id": null,
"home_page": "https://github.com/Bertin-fap/HalApyJson",
"name": "HalApyJson",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Metadata parsing, HAL request, API management",
"author": "BiblioAnalysis team",
"author_email": "francois.bertin7@wanadoo.fr, amal.chabli@orange.fr",
"download_url": "https://files.pythonhosted.org/packages/97/f7/f7e2f3f0a75dd132222d85d6a4825a7c53d5ee3326c75f9a5b5473a0f0b2/HalApyJson-1.1.3.tar.gz",
"platform": null,
"description": "# HalApyJson\r\n## Description\r\nA light interface to query [HAL](https://api.archives-ouvertes.fr/docs) through its API.\r\n\r\n## Installation\r\nRun the following to install:\r\n```python\r\npip install HalApyJson\r\n```\r\n\r\n## Usage example\r\n```python\r\nimport HalApyJson as haj\r\nyear = \"2023\"\r\ninstitute = \"Liten\"\r\nhal_df = haj.build_hal_df_from_api(year,institute)\r\nhal_df.to_excel(<your_fullpath_file.xlsx>, index = False)\r\n```\r\n**CLI exemple**\r\n```python\r\ncli_hal -y 2023 -i liten\r\n```\r\n**for more exemples refer to** [HalApyJson-exemples](https://github.com/Bertin-fap/HalApyJson/blob/main/Demo_HalApyJson.ipynb).\r\n\r\n\r\n# Release History\r\n- 1.0.0 first release\r\n- 1.1.0 added CLI\r\n- 1.1.1 removed prints\r\n- 1.1.2 updated CLI\r\n- 1.1.3 refactored code after pylint scan\r\n\r\n\r\n# Meta\r\n\t- authors : BiblioAnalysis team\r\n\r\nDistributed under the [MIT license](https://mit-license.org/)\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python modules for parsing the response to a HAL API request",
"version": "1.1.3",
"project_urls": {
"Homepage": "https://github.com/Bertin-fap/HalApyJson"
},
"split_keywords": [
"metadata parsing",
" hal request",
" api management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "63c3aa9b7917bf6e7d1e482c3ccc776c4314f6d848b9022468b405b1b100bc49",
"md5": "314de52538034184e71d5f0ecbc84b98",
"sha256": "b73c4f0c808d7526263d9c9f1fb9ed93be90c50447dbe39fc780da71543a66e5"
},
"downloads": -1,
"filename": "HalApyJson-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "314de52538034184e71d5f0ecbc84b98",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11435,
"upload_time": "2025-03-09T07:36:56",
"upload_time_iso_8601": "2025-03-09T07:36:56.824749Z",
"url": "https://files.pythonhosted.org/packages/63/c3/aa9b7917bf6e7d1e482c3ccc776c4314f6d848b9022468b405b1b100bc49/HalApyJson-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97f7f7e2f3f0a75dd132222d85d6a4825a7c53d5ee3326c75f9a5b5473a0f0b2",
"md5": "761fc751a51deeb16ecd09598dd3e541",
"sha256": "50fdbcd0203a4e0237079bcc484a2fec5d9aec355d8411be3e0135a1350be709"
},
"downloads": -1,
"filename": "HalApyJson-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "761fc751a51deeb16ecd09598dd3e541",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7875,
"upload_time": "2025-03-09T07:36:58",
"upload_time_iso_8601": "2025-03-09T07:36:58.190008Z",
"url": "https://files.pythonhosted.org/packages/97/f7/f7e2f3f0a75dd132222d85d6a4825a7c53d5ee3326c75f9a5b5473a0f0b2/HalApyJson-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-09 07:36:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Bertin-fap",
"github_project": "HalApyJson",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "openpyxl",
"specs": [
[
"==",
"3.1.2"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.1.4"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
}
],
"lcname": "halapyjson"
}