readeck 0.1.0__tar.gz

readeck-0.1.0/.gitignore

@@ -0,0 +1,176 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is not recommended to check in the commonly ignored directories such as
+#  .idea/ unless you have good reasons to do so.
+.idea/
+
+# VS Code
+.vscode/
+
+# uv
+.uv/
+uv.lock
+
+# macOS
+.DS_Store
+
+# Test artifacts
+.pytest_cache/
+htmlcov/
+.coverage
+coverage.xml

readeck-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yash Vanzara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

readeck-0.1.0/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: readeck
+Version: 0.1.0
+Summary: Python client library for Readeck APIs
+Project-URL: Homepage, https://github.com/yashvanzara/readeck-python
+Project-URL: Documentation, https://github.com/yashvanzara/readeck-python#readme
+Project-URL: Repository, https://github.com/yashvanzara/readeck-python
+Project-URL: Issues, https://github.com/yashvanzara/readeck-python/issues
+Author-email: Yash Vanzara <yashvanzara@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,bookmark,client,readeck,reader
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: flake8>=6.0.0; extra == 'dev'
+Requires-Dist: isort>=5.12.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.21.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Readeck Python Client
+
+A Python client library for the Readeck API, providing easy access to Readeck's bookmark and reading features.
+
+## Features
+
+- Full async/await support
+- Type hints with Pydantic models
+- Comprehensive error handling
+- Support for Python 3.10+
+- Easy authentication with Bearer tokens
+
+## Installation
+
+```bash
+pip install readeck
+```
+
+## Quick Start
+
+```python
+import asyncio
+from readeck import ReadeckClient
+
+async def main():
+    client = ReadeckClient(
+        base_url="https://your-readeck-instance.com",
+        token="your-bearer-token"
+    )
+
+    # Get user profile
+    profile = await client.get_user_profile()
+    print(f"Welcome, {profile.user.username}!")
+
+    # Create a bookmark
+    result = await client.create_bookmark(
+        url="https://example.com/article",
+        title="Interesting Article",
+        labels=["reading", "tech"]
+    )
+    print(f"Bookmark created with ID: {result.bookmark_id}")
+
+    await client.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Authentication
+
+The client uses Bearer token authentication. You can obtain your token from your Readeck instance's settings.
+
+```python
+client = ReadeckClient(
+    base_url="https://your-readeck-instance.com",
+    token="your-bearer-token"
+)
+```
+
+## API Reference
+
+### User Profile
+
+Get the current user's profile information:
+
+```python
+profile = await client.get_user_profile()
+```
+
+Returns a `UserProfile` object containing:
+- User information (username, email, creation date)
+- Authentication provider details
+- User settings and preferences
+- Reader settings (font, font size, line height)
+
+### Bookmarks
+
+#### Create Bookmark
+
+Create a new bookmark:
+
+```python
+# Minimal bookmark
+result = await client.create_bookmark(url="https://example.com")
+
+# Bookmark with title
+result = await client.create_bookmark(
+    url="https://example.com/article",
+    title="Article Title"
+)
+
+# Bookmark with labels
+result = await client.create_bookmark(
+    url="https://example.com/tutorial",
+    labels=["tutorial", "programming"]
+)
+
+# Complete bookmark
+result = await client.create_bookmark(
+    url="https://example.com/complete",
+    title="Complete Example",
+    labels=["example", "complete", "demo"]
+)
+```
+
+The `create_bookmark` method returns a `BookmarkCreateResult` object containing:
+- `response`: The API response with message and status
+- `bookmark_id`: The ID of the created bookmark (from response headers)
+- `location`: The URL of the created resource (from response headers)
+
+#### Get Bookmarks
+
+Retrieve bookmarks with optional filtering:
+
+```python
+# Get all bookmarks
+bookmarks = await client.get_bookmarks()
+
+# Get bookmarks with parameters
+from readeck import BookmarkListParams
+
+params = BookmarkListParams(
+    limit=10,
+    search="python",
+    labels="programming"
+)
+bookmarks = await client.get_bookmarks(params)
+```
+
+## Development
+
+This project uses `uv` for dependency management:
+
+```bash
+# Install dependencies
+uv sync --dev
+
+# Run tests
+uv run pytest
+
+# Run linting
+uv run black src tests
+uv run isort src tests
+uv run flake8 src tests
+uv run mypy src
+
+# Run all checks
+uv run pre-commit run --all-files
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

readeck-0.1.0/README.md

@@ -0,0 +1,157 @@
+# Readeck Python Client
+
+A Python client library for the Readeck API, providing easy access to Readeck's bookmark and reading features.
+
+## Features
+
+- Full async/await support
+- Type hints with Pydantic models
+- Comprehensive error handling
+- Support for Python 3.10+
+- Easy authentication with Bearer tokens
+
+## Installation
+
+```bash
+pip install readeck
+```
+
+## Quick Start
+
+```python
+import asyncio
+from readeck import ReadeckClient
+
+async def main():
+    client = ReadeckClient(
+        base_url="https://your-readeck-instance.com",
+        token="your-bearer-token"
+    )
+
+    # Get user profile
+    profile = await client.get_user_profile()
+    print(f"Welcome, {profile.user.username}!")
+
+    # Create a bookmark
+    result = await client.create_bookmark(
+        url="https://example.com/article",
+        title="Interesting Article",
+        labels=["reading", "tech"]
+    )
+    print(f"Bookmark created with ID: {result.bookmark_id}")
+
+    await client.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Authentication
+
+The client uses Bearer token authentication. You can obtain your token from your Readeck instance's settings.
+
+```python
+client = ReadeckClient(
+    base_url="https://your-readeck-instance.com",
+    token="your-bearer-token"
+)
+```
+
+## API Reference
+
+### User Profile
+
+Get the current user's profile information:
+
+```python
+profile = await client.get_user_profile()
+```
+
+Returns a `UserProfile` object containing:
+- User information (username, email, creation date)
+- Authentication provider details
+- User settings and preferences
+- Reader settings (font, font size, line height)
+
+### Bookmarks
+
+#### Create Bookmark
+
+Create a new bookmark:
+
+```python
+# Minimal bookmark
+result = await client.create_bookmark(url="https://example.com")
+
+# Bookmark with title
+result = await client.create_bookmark(
+    url="https://example.com/article",
+    title="Article Title"
+)
+
+# Bookmark with labels
+result = await client.create_bookmark(
+    url="https://example.com/tutorial",
+    labels=["tutorial", "programming"]
+)
+
+# Complete bookmark
+result = await client.create_bookmark(
+    url="https://example.com/complete",
+    title="Complete Example",
+    labels=["example", "complete", "demo"]
+)
+```
+
+The `create_bookmark` method returns a `BookmarkCreateResult` object containing:
+- `response`: The API response with message and status
+- `bookmark_id`: The ID of the created bookmark (from response headers)
+- `location`: The URL of the created resource (from response headers)
+
+#### Get Bookmarks
+
+Retrieve bookmarks with optional filtering:
+
+```python
+# Get all bookmarks
+bookmarks = await client.get_bookmarks()
+
+# Get bookmarks with parameters
+from readeck import BookmarkListParams
+
+params = BookmarkListParams(
+    limit=10,
+    search="python",
+    labels="programming"
+)
+bookmarks = await client.get_bookmarks(params)
+```
+
+## Development
+
+This project uses `uv` for dependency management:
+
+```bash
+# Install dependencies
+uv sync --dev
+
+# Run tests
+uv run pytest
+
+# Run linting
+uv run black src tests
+uv run isort src tests
+uv run flake8 src tests
+uv run mypy src
+
+# Run all checks
+uv run pre-commit run --all-files
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

readeck-0.1.0/pyproject.toml

@@ -0,0 +1,150 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "readeck"
+dynamic = ["version"]
+description = "Python client library for Readeck APIs"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "Yash Vanzara", email = "yashvanzara@gmail.com" },
+]
+keywords = ["readeck", "api", "client", "bookmark", "reader"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "httpx>=0.24.0",
+    "pydantic>=2.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-httpx>=0.21.0",
+    "black>=23.0.0",
+    "isort>=5.12.0",
+    "flake8>=6.0.0",
+    "mypy>=1.0.0",
+    "pre-commit>=3.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/yashvanzara/readeck-python"
+Documentation = "https://github.com/yashvanzara/readeck-python#readme"
+Repository = "https://github.com/yashvanzara/readeck-python"
+Issues = "https://github.com/yashvanzara/readeck-python/issues"
+
+[tool.hatch.version]
+path = "src/readeck/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/readeck"]
+
+[tool.black]
+line-length = 88
+target-version = ['py310']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+line_length = 88
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py", "*_test.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+asyncio_default_fixture_loop_scope = "function"
+asyncio_mode = "auto"
+addopts = [
+    "--cov=src/readeck",
+    "--cov-report=term-missing",
+    "--cov-report=html",
+    "--cov-fail-under=80",
+]
+
+[tool.coverage.run]
+source = ["src"]
+omit = ["*/tests/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+]
+
+[dependency-groups]
+dev = [
+    "black>=24.8.0",
+    "flake8>=7.1.2",
+    "isort>=5.13.2",
+    "mypy>=1.14.1",
+    "pre-commit>=3.5.0",
+    "pytest>=7.4.4",
+    "pytest-asyncio>=0.23.8",
+    "pytest-cov>=5.0.0",
+    "pytest-httpx>=0.22.0",
+    "twine>=6.1.0",
+]
+
+[tool.flake8]
+ignore = ["E231"]