Skip to content

Commit e7ea5e5

Browse files
author
Gerit Wagner
committed
package: enlit
1 parent d5a52c1 commit e7ea5e5

15 files changed

Lines changed: 524 additions & 3 deletions

File tree

‎colrev/package_manager/package_endpoints.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -686,6 +686,11 @@
686686
"status": "|MATURING|",
687687
"short_description": "Doi.org (:doc:`instructions </manual/packages/colrev.doi_org>`)"
688688
},
689+
{
690+
"package_endpoint_identifier": "colrev.enlit",
691+
"status": "|EXPERIMENTAL|",
692+
"short_description": "TODO (:doc:`instructions </manual/packages/colrev.enlit>`)"
693+
},
689694
{
690695
"package_endpoint_identifier": "colrev.ui_web",
691696
"status": "|MATURING|",

‎colrev/package_manager/packages.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,5 +286,8 @@
286286
},
287287
"colrev.cli_prep_man": {
288288
"dev_status": "experimental"
289+
},
290+
"colrev.enlit": {
291+
"dev_status": "experimental"
289292
}
290293
}

‎colrev/packages/cli_prep_man/docs/README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# TODO : Docs
2-
1+
## Summary
32

43
Standalone call:
54

‎colrev/packages/cli_prep_man/pyproject.toml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ authors = [
77
{ name = "Gerit Wagner", email = "gerit.wagner@uni-bamberg.de" }
88
]
99
requires-python = ">=3.8, <4"
10-
urls = { "Repository" = "https://github.com/CoLRev-Environment/colrev/tree/main/colrev/packages/" }
10+
11+
[project.urls]
12+
repository = "https://github.com/CoLRev-Environment/colrev/tree/main/colrev/packages/"
1113

1214
[tool.hatch.build.targets.wheel]
1315
packages = ["src"]

‎colrev/packages/enlit/.pre-commit-config.yaml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
2+
repos:
3+
- repo: https://github.com/pre-commit/pre-commit-hooks
4+
rev: v4.6.0
5+
hooks:
6+
- id: trailing-whitespace
7+
- id: end-of-file-fixer
8+
exclude: bib$|txt$|ris$|enl$|xml$
9+
- id: check-docstring-first
10+
- id: check-json
11+
- id: check-yaml
12+
- id: check-toml
13+
- id: debug-statements
14+
- id: name-tests-test
15+
- repo: https://github.com/psf/black-pre-commit-mirror
16+
rev: 24.4.2
17+
hooks:
18+
- id: black
19+
language_version: python3
20+
- repo: https://github.com/PyCQA/autoflake
21+
rev: v2.3.1
22+
hooks:
23+
- id: autoflake
24+
- repo: https://github.com/PyCQA/flake8
25+
rev: 7.1.0
26+
hooks:
27+
- id: flake8
28+
additional_dependencies: [flake8-typing-imports==1.12.0]
29+
args: ['--max-line-length=110', '--extend-ignore=E203,TYP006']
30+
- repo: https://github.com/asottile/reorder-python-imports
31+
rev: v3.13.0
32+
hooks:
33+
- id: reorder-python-imports
34+
args: [--py3-plus]
35+
- repo: https://github.com/asottile/pyupgrade
36+
rev: v3.16.0
37+
hooks:
38+
- id: pyupgrade
39+
args: [--py36-plus, --keep-runtime-typing]
40+
- repo: https://github.com/pre-commit/mirrors-mypy
41+
rev: 'v1.11.0'
42+
hooks:
43+
- id: mypy
44+
args: [--disallow-untyped-defs, --disallow-incomplete-defs, --disallow-untyped-calls]
45+
additional_dependencies: [types-toml]
46+
- repo: https://github.com/astral-sh/ruff-pre-commit
47+
rev: v0.5.4
48+
hooks:
49+
- id: ruff # runs faster than pylint
50+
args: [--fix, --exit-non-zero-on-fix]
51+
- repo: local
52+
hooks:
53+
- id: pylint
54+
name: pylint
55+
entry: pylint
56+
language: system
57+
types: [python]
58+
files: colrev
59+
args:
60+
[
61+
"-rn", # Only display messages
62+
"-sn", # Don't display the score
63+
]

‎colrev/packages/enlit/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) [2025] [Gerit Wagner]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎colrev/packages/enlit/README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# colrev.enlit
2+
3+
ENLIT is a tool that supports scholars in exploring new literature:
4+
5+
- It makes **backward searches more efficient** by extracting the references from a literature corpus (set of PDFs) and providing a list without duplicates. It also provides statistics on journals and authors that are cited frequently by the given literature corpus.
6+
- It implements a **new exploratory strategy that facilitates understanding**: simply start by reading the most influential papers and skim the remaining papers afterwards. A paper that explains why this strategy is more effective than the traditional skim first and read afterwards approach will be published soon.
7+
8+
Authors
9+
10+
- Philip Empl - University of Regensburg
11+
- Gerit Wagner - Otto-Friedrich-Universität Bamberg
12+
13+
## Installation
14+
15+
```bash
16+
colrev install colrev.enlit
17+
```
18+
19+
## Usage
20+
21+
```bash
22+
colrev_enlit
23+
```
24+
25+
## Cite
26+
27+
Wagner, G., Empl, P., & Schryen, G. (2020, May). Designing a novel strategy for exploring literature corpora. In *Proceedings of the European Conference on Information Systems*. https://aisel.aisnet.org/ecis2020_rp/44/
28+
29+
Original repository: [link](https://github.com/digital-work-lab/enlit)
30+
31+
## License
32+
33+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

‎colrev/packages/enlit/docs/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Summary
2+
3+
ENLIT is a tool that supports scholars in exploring new literature:
4+
5+
- It makes **backward searches more efficient** by extracting the references from a literature corpus (set of PDFs) and providing a list without duplicates. It also provides statistics on journals and authors that are cited frequently by the given literature corpus.
6+
- It implements a **new exploratory strategy that facilitates understanding**: simply start by reading the most influential papers and skim the remaining papers afterwards. A paper that explains why this strategy is more effective than the traditional skim first and read afterwards approach will be published soon.
7+
8+
Authors
9+
10+
- Philip Empl - University of Regensburg
11+
- Gerit Wagner - Otto-Friedrich-Universität Bamberg
12+
13+
## Installation
14+
15+
```bash
16+
colrev install colrev.enlit
17+
```
18+
19+
## Usage
20+
21+
Run the following command in a CoLRev repository:
22+
23+
```bash
24+
colrev_enlit
25+
```
26+
27+
## Cite
28+
29+
Wagner, G., Empl, P., & Schryen, G. (2020, May). Designing a novel strategy for exploring literature corpora. In *Proceedings of the European Conference on Information Systems*. https://aisel.aisnet.org/ecis2020_rp/44/
30+
31+
Original repository: [link](https://github.com/digital-work-lab/enlit)
32+
33+
## License
34+
35+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

‎colrev/packages/enlit/pyproject.toml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[project]
2+
name = "colrev.enlit"
3+
description = "ENLIT"
4+
version = "0.1.0"
5+
license = "MIT"
6+
authors = [
7+
{ name = "Gerit Wagner", email = "gerit.wagner@uni-bamberg.de" }
8+
]
9+
requires-python = ">=3.8, <4"
10+
11+
[project.urls]
12+
repository = "https://github.com/CoLRev-Environment/colrev/tree/main/colrev/packages/enlit"
13+
14+
[tool.hatch.build.targets.wheel]
15+
packages = ["src"]
16+
17+
[tool.colrev]
18+
colrev_doc_description = "TODO"
19+
colrev_doc_link = "docs/README.md"
20+
search_types = []
21+
22+
[project.scripts]
23+
colrev_enlit = "colrev.packages.enlit.src.enlit:main"
24+
25+
[build-system]
26+
requires = ["hatchling"]
27+
build-backend = "hatchling.build"

‎colrev/packages/enlit/src/__init__.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
"""Package for colrev.enlit."""
2+
3+
__author__ = "Gerit Wagner"
4+
__email__ = "gerit.wagner@uni-bamberg.de"

0 commit comments

Comments
 (0)