Upload this project to PyPI (#2)

This commit is contained in:
Ivan R. 2022-12-16 21:36:48 +05:00
parent 3d63e3d4b9
commit c52b62c384
No known key found for this signature in database
GPG key ID: 56C7BAAE859B302C
5 changed files with 32 additions and 14 deletions

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
/dist
__pycache__

24
pyproject.toml Normal file
View file

@ -0,0 +1,24 @@
[project]
name = "histd"
version = "0.0.1"
authors = [
{ name="Ivan Reshetnikov", email="ordinarydev@protonmail.com" },
]
description = "A simple but useful personal diary application"
readme = "readme.md"
requires-python = ">=3.7"
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: POSIX :: Linux",
"Topic :: Utilities",
]
[project.urls]
"Homepage" = "https://github.com/ordinary-dev/histd"
"Bug Tracker" = "https://github.com/ordinary-dev/histd/issues"
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

View file

@ -16,31 +16,23 @@ tree ~/.local/share/histd
```
## Usage
```sh
python3 histd.py
```bash
python -m histd
```
## Installation
Recommended method
```sh
sudo cp histd.py /usr/local/bin/histd
```bash
pip install histd
```
Risky way (without cloning the repository)
```sh
sudo curl -o /usr/local/bin/histd "https://raw.githubusercontent.com/ordinary-dev/histd/master/histd.py"
```
To create a new note, you can simply type `histd` in the terminal.
## Backup
To create an archive of all notes, run the following command:
```bash
histd backup
python -m histd backup
```
## Merge all notes
This command concatenates all files and prefixes each with the filename.
```bash
histd merge
python -m histd merge
```

0
src/histd/__init__.py Normal file
View file