Skip to content

Commit 067b2ca

Browse files
committed
add pip install ubuntu
1 parent f5c932f commit 067b2ca

File tree

3 files changed

+82
-9
lines changed

3 files changed

+82
-9
lines changed

.github/workflows/release.yml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Release
2+
3+
# This workflow runs on any tag push
4+
on:
5+
push:
6+
tags:
7+
- "*"
8+
9+
# These permissions are necessary for trusted publishing to PyPI,
10+
# and creating a GitHub Release
11+
permissions:
12+
contents: write
13+
id-token: write
14+
15+
jobs:
16+
lint:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
21+
- name: Install uv
22+
uses: astral-sh/setup-uv@v3
23+
with:
24+
version: "latest"
25+
enable-cache: true
26+
27+
- name: Install dependencies
28+
run: uv sync --dev
29+
30+
- name: Run type checking
31+
run: uv run mypy .
32+
33+
- name: Run linting
34+
run: uv run ruff check .
35+
36+
test:
37+
runs-on: ubuntu-latest
38+
strategy:
39+
matrix:
40+
python-version: ["3.10", "3.11", "3.12", "3.13"]
41+
42+
steps:
43+
- uses: actions/checkout@v4
44+
45+
- name: Install uv
46+
uses: astral-sh/setup-uv@v3
47+
with:
48+
version: "latest"
49+
enable-cache: true
50+
51+
- name: Install dependencies
52+
run: uv sync --dev --python ${{ matrix.python-version }}
53+
54+
- name: Run tests
55+
run: uv run pytest
56+
57+
build-and-publish:
58+
# This job only runs if the lint and test jobs pass
59+
needs: [lint, test]
60+
runs-on: ubuntu-latest
61+
62+
steps:
63+
- uses: actions/checkout@v4
64+
65+
- name: Install uv
66+
uses: astral-sh/setup-uv@v3
67+
with:
68+
version: "latest"
69+
enable-cache: true
70+
71+
- name: Build package
72+
run: uv build
73+
74+
- name: Publish to PyPI
75+
uses: pypa/gh-action-pypi-publish@release/v1

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,18 @@ zypper in python3-poppler-qt5 python3-feedparser python3-qt5 python3-httplib2
3030
How you can install and test locally:
3131

3232
```bash
33+
pip install piepdf
3334
```
3435

36+
OR
37+
3538
From the project root run: `pip install -e .`
39+
3640
Then run:
3741
```bash
3842
piepdf
3943
```
40-
(or `python -m piepdf` )
41-
4244

43-
44-
```
45-
git clone https://github.com/srbhp/PiePdf.git
46-
cd PiePdf
47-
python3 src/piepdf
48-
```
4945
By default it create a folder `PiePdf`
5046
in your home directory. You can change this default directory to any `Path` from the setiing menu.
5147
You have keep all your pdfs in this directory. *PiePdf* fetch metadata automatically

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
[project]
22
name = "piepdf"
33
version = "0.1.0"
4-
description = "Add your description here"
4+
description = "Manage Research Articles and fetch metadata from the internet"
5+
56
readme = "README.md"
67
requires-python = ">=3.12"
78
dependencies = [
@@ -13,6 +14,7 @@ dependencies = [
1314
"sip>=6.9.0",
1415
"feedparser>=6.0.11",
1516
"httplib2>=0.22.0",
17+
"pyqt5-qt5>=5.15.18",
1618
]
1719

1820
[project.scripts]

0 commit comments

Comments
 (0)