https://github.com/nidhaloff/bookmarks
save and sync browser bookmarks automatically
https://github.com/nidhaloff/bookmarks
Last synced: 3 months ago
JSON representation
save and sync browser bookmarks automatically
- Host: GitHub
- URL: https://github.com/nidhaloff/bookmarks
- Owner: nidhaloff
- License: mit
- Created: 2023-04-14T22:21:19.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-14T22:45:15.000Z (over 2 years ago)
- Last Synced: 2025-04-02T20:45:53.067Z (6 months ago)
- Size: 8.79 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# bookmarks
[](https://pypi.python.org/pypi/bookmarks/)
[](https://pypi.python.org/pypi/bookmarks/)
[](https://pypi.python.org/pypi/bookmarks/)
[](https://github.com/woltapp/wolt-python-package-cookiecutter)
---
**Documentation**: [https://nidhaloff.github.io/bookmarks](https://nidhaloff.github.io/bookmarks)
**Source Code**: [https://github.com/nidhaloff/bookmarks](https://github.com/nidhaloff/bookmarks)
**PyPI**: [https://pypi.org/project/bookmarks/](https://pypi.org/project/bookmarks/)
---
store and sync your browser bookmarks automatically
## Installation
```sh
pip install bookmarks
```
## Development
* Clone this repository
* Requirements:
* [Poetry](https://python-poetry.org/)
* Python 3.7+
* Create a virtual environment and install the dependencies
```sh
poetry install
```
* Activate the virtual environment
```sh
poetry shell
```
### Testing
```sh
pytest
```
### Documentation
The documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings
of the public signatures of the source code. The documentation is updated and published as a [Github project page
](https://pages.github.com/) automatically as part each release.
### Releasing
Trigger the [Draft release workflow](https://github.com/nidhaloff/bookmarks/actions/workflows/draft_release.yml)
(press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.
Find the draft release from the
[GitHub releases](https://github.com/nidhaloff/bookmarks/releases) and publish it. When
a release is published, it'll trigger [release](https://github.com/nidhaloff/bookmarks/blob/master/.github/workflows/release.yml) workflow which creates PyPI
release and deploys updated documentation.
### Pre-commit
Pre-commit hooks run all the auto-formatters (e.g. `black`, `isort`), linters (e.g. `mypy`, `flake8`), and other quality
checks to make sure the changeset is in good shape before a commit/push happens.
You can install the hooks with (runs for each commit):
```sh
pre-commit install
```
Or if you want them to run only for each push:
```sh
pre-commit install -t pre-push
```
Or if you want e.g. want to run all checks manually for all files:
```sh
pre-commit run --all-files
```
---
This project was generated using the [wolt-python-package-cookiecutter](https://github.com/woltapp/wolt-python-package-cookiecutter) template.