Skip to content

Commit 9e89c8a

Browse files
committed
Rename acl-anthology-py to acl-anthology
1 parent 11301fb commit 9e89c8a

File tree

10 files changed

+21
-24
lines changed

10 files changed

+21
-24
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![GitHub contributors](https://img.shields.io/github/contributors/acl-org/acl-anthology)](https://github.com/acl-org/acl-anthology/graphs/contributors)
55
[![Good first project issues](https://img.shields.io/github/issues/acl-org/acl-anthology/good%20first%20project)](https://github.com/acl-org/acl-anthology/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+project%22)
66
[![License](https://img.shields.io/github/license/acl-org/acl-anthology)](LICENSE)
7-
[![acl-anthology-py on PyPI](https://img.shields.io/pypi/v/acl-anthology-py?logo=python&label=acl-anthology-py&labelColor=lightgray&color=3776AB)](https://pypi.org/project/acl-anthology-py/)
7+
[![acl-anthology on PyPI](https://img.shields.io/pypi/v/acl-anthology?logo=python&label=acl-anthology&labelColor=lightgray&color=3776AB)](https://pypi.org/project/acl-anthology/)
88

99
This repository contains:
1010

@@ -14,7 +14,7 @@ This repository contains:
1414

1515
The official home of this repository is <https://github.com/acl-org/acl-anthology>.
1616

17-
## Using the acl-anthology-py Python package
17+
## Using the acl-anthology Python package
1818

1919
Please see the separate [README for the Python package](python/README.md) for detailed information.
2020

README_detailed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ comprise:
122122
defines which author names should be treated as identical for purposes of
123123
generating "author" pages.
124124

125-
The "acl-anthology-py" module under [`python/`](python/) is responsible
125+
The "acl-anthology" module under [`python/`](python/) is responsible
126126
for parsing and interpreting all these data files. Some information that is not
127127
explicitly stored in any of these files is *derived automatically* by this
128128
module during Step 1 of building the website.

python/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
# acl-anthology-py
1+
# acl-anthology
22

33
[![License](https://img.shields.io/github/license/acl-org/acl-anthology)](LICENSE)
44
[![Build Status](https://img.shields.io/github/actions/workflow/status/acl-org/acl-anthology/code-quality.yml)](https://github.com/acl-org/acl-anthology/actions/workflows/code-quality.yml)
5-
[![Documentation](https://img.shields.io/readthedocs/acl-anthology-py)](https://acl-anthology-py.readthedocs.io/en/latest/)
5+
[![Documentation](https://img.shields.io/readthedocs/acl-anthology)](https://acl-anthology.readthedocs.io/en/latest/)
66
[![Code Coverage](https://img.shields.io/codecov/c/gh/acl-org/acl-anthology)](https://codecov.io/gh/acl-org/acl-anthology)
7-
![Supported Python Versions](https://img.shields.io/pypi/pyversions/acl-anthology-py)
8-
![Development Status](https://img.shields.io/pypi/status/acl-anthology-py)
9-
[![Package on PyPI](https://img.shields.io/pypi/v/acl-anthology-py)](https://pypi.org/project/acl-anthology-py/)
7+
![Supported Python Versions](https://img.shields.io/pypi/pyversions/acl-anthology)
8+
![Development Status](https://img.shields.io/pypi/status/acl-anthology)
9+
[![Package on PyPI](https://img.shields.io/pypi/v/acl-anthology)](https://pypi.org/project/acl-anthology/)
1010

1111
This package accesses data from the [ACL
1212
Anthology](https://aclanthology.org).
1313

14-
- [**Documentation**](https://acl-anthology-py.readthedocs.io/en/latest/)
15-
- [**Package on PyPI**](https://pypi.org/project/acl-anthology-py/)
14+
- [**Documentation**](https://acl-anthology.readthedocs.io/en/latest/)
15+
- [**Package on PyPI**](https://pypi.org/project/acl-anthology/)
1616

1717
## How to use
1818

1919
Install via `pip`:
2020

2121
```bash
22-
$ pip install acl-anthology-py
22+
$ pip install acl-anthology
2323
```
2424

2525
Instantiate the library, automatically fetching data files from the [ACL
@@ -53,7 +53,7 @@ Two-Level Morphology with Composition
5353
```
5454

5555
Find more examples and details on the API in the [**official
56-
documentation**](https://acl-anthology-py.readthedocs.io/en/latest/).
56+
documentation**](https://acl-anthology.readthedocs.io/en/latest/).
5757

5858
## Developing
5959

python/acl_anthology/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,5 @@ class DefaultConfig:
5555
config = OmegaConf.structured(DefaultConfig)
5656
"""A [structured configuration instance](https://omegaconf.readthedocs.io/en/latest/structured_config.html) that is used by all `acl_anthology` classes."""
5757

58-
dirs = PlatformDirs("acl-anthology-py")
58+
dirs = PlatformDirs("acl-anthology")
5959
"""A [PlatformDirs instance](https://platformdirs.readthedocs.io/en/latest/api.html#platformdirs) that returns platform-specific directories for storing data."""

python/acl_anthology/exceptions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,5 +75,5 @@ class SchemaMismatchWarning(UserWarning):
7575
def __init__(self) -> None:
7676
super().__init__(
7777
"Data directory contains a different schema.rnc as this library; "
78-
"you might need to update the data or the acl-anthology-py library."
78+
"you might need to update the data or the acl-anthology library."
7979
)

python/docs/api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# API Documentation
22

3-
This is the API documentation for acl-anthology-py.
3+
This is the API documentation for the acl-anthology Python package.

python/docs/guide/getting-started.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,13 @@ fetching data from the main ACL Anthology repository, you will also need to have
77
## Installation
88

99
The library is available as a [PyPI
10-
package](https://pypi.org/project/acl-anthology-py/) and can therefore simply be
10+
package](https://pypi.org/project/acl-anthology/) and can therefore simply be
1111
installed via pip:
1212

1313
```bash
14-
pip install acl-anthology-py
14+
pip install acl-anthology
1515
```
1616

17-
Alternatively, you can [download releases from
18-
Github](https://github.com/acl-org/acl-anthology/releases/).
19-
2017
## Instantiating the Anthology
2118

2219
### From the official repository

python/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ can even use this library to programmatically make changes to the metadata.
1818
This package requires **Python 3.10 or newer**. Install via pip:
1919

2020
```bash
21-
pip install acl-anthology-py
21+
pip install acl-anthology
2222
```
2323

2424
Instantiate the library, automatically fetching data files from the [ACL

python/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: acl-anthology-py
1+
site_name: acl-anthology
22
site_author: Marcel Bollmann
33
repo_url: https://github.com/acl-org/acl-anthology
44
repo_name: acl-org/acl-anthology
@@ -101,7 +101,7 @@ extra:
101101
social:
102102
- icon: fontawesome/brands/github
103103
link: https://github.com/acl-org/acl-anthology
104-
name: acl-anthology-py on Github
104+
name: acl-anthology on Github
105105
- icon: material/web
106106
link: https://aclanthology.org/
107107
name: ACL Anthology Website

python/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ target-version = 'py310'
3131
ignore = ['E501'] # "Line too long" is black's job
3232

3333
[tool.poetry]
34-
name = "acl-anthology-py"
34+
name = "acl-anthology"
3535
packages = [
3636
{ include = "acl_anthology" },
3737
]

0 commit comments

Comments
 (0)