Skip to content

Commit fa44933

Browse files
committed
Update README and pyproject.toml
1 parent b67b544 commit fa44933

File tree

3 files changed

+846
-58
lines changed

3 files changed

+846
-58
lines changed

README.md

Lines changed: 7 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,21 @@
11
# ezplot
22

3-
[![Release](https://img.shields.io/github/v/release/phuongho43/ezplot)](https://img.shields.io/github/v/release/phuongho43/ezplot)
4-
[![Build status](https://img.shields.io/github/actions/workflow/status/phuongho43/ezplot/main.yml?branch=main)](https://github.com/phuongho43/ezplot/actions/workflows/main.yml?query=branch%3Amain)
5-
[![codecov](https://codecov.io/gh/phuongho43/ezplot/branch/main/graph/badge.svg)](https://codecov.io/gh/phuongho43/ezplot)
6-
[![Commit activity](https://img.shields.io/github/commit-activity/m/phuongho43/ezplot)](https://img.shields.io/github/commit-activity/m/phuongho43/ezplot)
7-
[![License](https://img.shields.io/github/license/phuongho43/ezplot)](https://img.shields.io/github/license/phuongho43/ezplot)
8-
93
Visualizing data from biology experiments.
104

11-
- **Github repository**: <https://github.com/phuongho43/ezplot/>
12-
- **Documentation** <https://phuongho43.github.io/ezplot/>
13-
14-
## Getting started with your project
15-
16-
### 1. Create a New Repository
5+
## Getting Started
176

18-
First, create a repository on GitHub with the same name as this project, and then run the following commands:
7+
### 1. Install [UV](https://docs.astral.sh/uv/getting-started/installation/)
198

209
```bash
21-
git init -b main
22-
git add .
23-
git commit -m "init commit"
24-
git remote add origin git@github.com:phuongho43/ezplot.git
25-
git push -u origin main
10+
$ curl -LsSf https://astral.sh/uv/install.sh | sh
2611
```
2712

28-
### 2. Set Up Your Development Environment
29-
30-
Then, install the environment and the pre-commit hooks with
31-
32-
```bash
33-
make install
34-
```
35-
36-
This will also generate your `uv.lock` file
37-
38-
### 3. Run the pre-commit hooks
13+
### 2. Specify file paths and plotting parameters
3914

40-
Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
15+
ezplot/plot\_[type].py
4116

42-
```bash
43-
uv run pre-commit run -a
44-
```
45-
46-
### 4. Commit the changes
47-
48-
Lastly, commit the changes made by the two steps above to your repository.
17+
### 3. Run plotting functions
4918

5019
```bash
51-
git add .
52-
git commit -m 'Fix formatting issues'
53-
git push origin main
20+
$ uv run plot_[type]
5421
```
55-
56-
You are now ready to start development on your project!
57-
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
58-
59-
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
60-
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
61-
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
62-
63-
## Releasing a new version
64-
65-
---
66-
67-
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).

pyproject.toml

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,22 @@ classifiers = [
1717
"Programming Language :: Python :: 3.13",
1818
"Topic :: Software Development :: Libraries :: Python Modules",
1919
]
20+
dependencies = [
21+
"fcsparser>=0.2.8",
22+
"matplotlib>=3.9.4",
23+
"natsort>=8.4.0",
24+
"numpy>=1.26.4",
25+
"pandas>=2.2.3",
26+
"seaborn>=0.13.2",
27+
]
2028

2129
[project.urls]
22-
Homepage = "https://phuongho43.github.io/ezplot/"
2330
Repository = "https://github.com/phuongho43/ezplot"
24-
Documentation = "https://phuongho43.github.io/ezplot/"
31+
32+
[project.scripts]
33+
plot_dynamics = "fluoressential.plot_dynamics:main"
34+
plot_groups = "fluoressential.plot_groups:main"
35+
plot_cytometry = "fluoressential.plot_cytometry:main"
2536

2637
[dependency-groups]
2738
dev = [
@@ -30,9 +41,7 @@ dev = [
3041
"tox-uv>=1.11.3",
3142
"deptry>=0.20.0",
3243
"mypy>=0.991",
33-
3444
"ruff>=0.6.9",
35-
3645
]
3746

3847
[build-system]
@@ -57,7 +66,7 @@ testpaths = ["tests"]
5766

5867
[tool.ruff]
5968
target-version = "py39"
60-
line-length = 120
69+
line-length = 200
6170
fix = true
6271

6372
[tool.ruff.lint]

0 commit comments

Comments
 (0)