Skip to content

Commit 2955baa

Browse files
committed
prepare for the first release
1 parent 6c768b2 commit 2955baa

File tree

4 files changed

+15
-8
lines changed

4 files changed

+15
-8
lines changed

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ jobs:
8080
if: github.event_name == 'workflow_dispatch' && github.event.inputs.environment == 'testpypi'
8181
environment:
8282
name: testpypi
83-
url: https://test.pypi.org/p/pycomptox
83+
url: https://test.pypi.org/p/comptox-python
8484

8585
permissions:
8686
id-token: write
@@ -104,7 +104,7 @@ jobs:
104104
if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.environment == 'pypi')
105105
environment:
106106
name: pypi
107-
url: https://pypi.org/p/pycomptox
107+
url: https://pypi.org/p/comptox-python
108108

109109
permissions:
110110
id-token: write

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PyCompTox
22

33
[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/downloads/)
4-
[![PyPI version](https://img.shields.io/pypi/v/pycomptox.svg)](https://pypi.org/project/pycomptox/)
4+
[![PyPI version](https://img.shields.io/pypi/v/comptox-python.svg)](https://pypi.org/project/comptox-python/)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66
[![Tests](https://github.com/USEtox/PyCompTox/workflows/CI/badge.svg)](https://github.com/USEtox/PyCompTox/actions/workflows/ci.yml)
77
[![Documentation Status](https://img.shields.io/badge/docs-mkdocs-blue.svg)](https://usetox.github.io/PyCompTox/)
@@ -18,10 +18,13 @@ PyCompTox provides a simple and intuitive Python interface to interact with the
1818
### Quick Install
1919

2020
```bash
21-
pip install pycomptox[all]
21+
pip install comptox-python[all]
2222
```
2323

24-
install the latest released version. For the latest development version:
24+
install the latest released version.
25+
**Note**: do not install the package by ~~`pip install pycomptox`~~ which is a different package with the old comptox API.
26+
27+
For the latest development version:
2528

2629
```bash
2730
# Clone the repository
@@ -107,4 +110,6 @@ See the LICENSE file for details.
107110
## Disclaimer
108111

109112
This package is not officially affiliated with or endorsed by the U.S. Environmental Protection Agency (EPA). It is an independent implementation of a Python client for the publicly available CompTox Dashboard API.
110-
You can find [the official Python client](https://github.com/USEPA/ctx-python) from the [official USEPA GitHub page](https://github.com/USEPA).
113+
You can find [the official Python client](https://github.com/USEPA/ctx-python) from the [official USEPA GitHub page](https://github.com/USEPA).
114+
115+
Also, note that there is another package called [pycomptox](https://github.com/Kunal627/pycomptox) that is registered on `PyPi` nder the same name, which is why this package is installed by `pip install comptox-python`.

docs/quick_start.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ Get up and running with PyCompTox in minutes!
1212
Install PyCompTox using pip:
1313

1414
```bash
15-
pip install pycomptox
15+
pip install comptox-python[all]
1616
```
1717

18+
**Note**: do not install the package by ~~`pip install pycomptox`~~ which is a different package with the old comptox API.
19+
1820
## API Key Configuration
1921

2022
Before using PyCompTox, you need to configure your API key.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0", "wheel"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "pycomptox"
6+
name = "comptox-python"
77
version = "0.6.0"
88
description = "A Python interface for the EPA CompTox Dashboard Chemical API"
99
readme = "README.md"

0 commit comments

Comments
 (0)