otripy 1.0.0__tar.gz

otripy-1.0.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.2
+Name: otripy
+Version: 1.0.0
+Summary: A tool to plan your next trip
+Author-email: "Gaël de Chalendar (aka Kleag)" <kleagg@gmail.com>
+License: AGPL
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: folium>=0.19.5
+Requires-Dist: geopy>=2.4.1
+Requires-Dist: lxml>=5.3.1
+Requires-Dist: markdown>=3.7
+Requires-Dist: nc-py-api>=0.19.0
+Requires-Dist: numpy>=2.2.3
+Requires-Dist: pillow>=11.1.0
+Requires-Dist: pyside6>=6.8.2.1
+Requires-Dist: typing-extensions>=4.12.2
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Provides-Extra: build
+Requires-Dist: bumpver; extra == "build"
+Provides-Extra: deploy
+Requires-Dist: uv; extra == "deploy"
+
+# Otripy - An open trip planning tool
+
+
+[![PyPI Version](https://img.shields.io/pypi/v/otripy)](https://pypi.org/project/otripy)
+[![License](https://img.shields.io/pypi/l/otripy)](https://github.com/kleag/otripy/blob/main/AGPL.md)
+[![Downloads](https://static.pepy.tech/badge/otripy/month)](https://pepy.tech/project/otripy)
+[![Supported Versions](https://img.shields.io/pypi/pyversions/otripy)](https://pypi.org/project/otripy)
+[![Contributors](https://img.shields.io/github/contributors/kleag/otripy)](https://github.com/kleag/otripy/graphs/contributors)
+
+<!--
+![Python Versions](https://img.shields.io/pypi/pyversions/otripy)
+![Build Status](https://img.shields.io/github/actions/workflow/status/kleag/otripy/ci.yml)
+-->
+
+## Description
+
+Otripy is a GUI application for trip planning, providing an intuitive user interface for organizing travel visits efficiently. Otripy allows to plan a trip by adding markers on a map (based on OpenStreetMap) associated with a note.
+
+Otripy is developed and daily tested on Linux. It should work on any platform. It has already been tested on MacOS.
+
+Otripy is already usable but would be better with a lot of other features. Some wanted features are listed [here](https://github.com/kleag/otripy/issues). Don't hesitate to create a new issue if you think at other features. And contribute them if you can!
+
+### Current features:
+
+* Display OpenStreetMap map
+* Zoom and pan the map
+* Adding location markers on the map
+* List existing location on the left part of the GUI
+* Associate a note to a location. The first line of the note is used as the title in the list
+* Search location by name, and add a new marker when selecting an entry in the list
+* Delete markers
+* Open and save local files
+* Open and save files on any Nextcloud server you have access to
+* Note text formatting (heading, bold, …)
+* Image insertion (copy paste only currently)
+
+## Screenshots
+
+![Otripy GUI snapshot](https://github.com/kleag/otripy/blob/main/pics/otripy-snapshot.png "Otripy GUI")
+
+## Installation
+
+### For users familiar with Python
+
+Otripy is on PyPi. To install it, run:
+
+```sh
+pip install otripy
+```
+
+### For all others
+
+If you are not used to installing Python packages, the simplest method is probably to use [uv](https://docs.astral.sh/uv/). Please [install it](https://docs.astral.sh/uv/getting-started/installation/) first. Then, open a terminal and create an uv virtual environment and activate it:
+
+
+```sh
+uv venv otripy
+source otripy/bin/activate
+```
+
+Then install Otripy and run it:
+
+```sh
+uv pip install otripy
+otripy
+```
+
+## Usage
+
+To launch the application:
+```bash
+otripy
+```
+
+## Building and publishing
+
+Otripy uses [uv](https://docs.astral.sh/uv/), please [install it](https://docs.astral.sh/uv/getting-started/installation/) if not already available.
+
+If you just cloned this repository, cd to it and then:
+
+```sh
+uv venv
+uv sync --all-extras
+uv pip install -r pyproject.toml --extra build
+install -d dist
+```
+
+Then, to build and publish:
+
+```sh
+rm dist/otripy-*
+bumpver update --patch # or --minor or --major
+uv build
+uv publish
+uv sync --all-extras
+git add uv.lock
+git commit -m "Update lock to new package version"
+```
+
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-name`).
+3. Commit changes (`git commit -m "Add feature"`).
+4. Push to your branch (`git push origin feature-name`).
+5. Open a pull request.
+
+## License
+This project is Free Software, licensed under the AGPL License. See the [AGPL](https://github.com/kleag/otripy/blob/main/AGPL.md) file for details. In summary: you can use it, share it, change it, redistribute your changes, but any version you offer, with or without changes must be under the same (or a compatible) license.
+
+## Credits
+Otripy is developed and maintained by [Kleag](https://github.com/kleag). Special thanks to all contributors!
+
+---
+
+For more information, visit the [GitHub repository](https://github.com/kleag/otripy) or the [PyPI page](https://pypi.org/project/otripy/).
+

otripy-1.0.0/README.md

@@ -0,0 +1,119 @@
+# Otripy - An open trip planning tool
+
+
+[![PyPI Version](https://img.shields.io/pypi/v/otripy)](https://pypi.org/project/otripy)
+[![License](https://img.shields.io/pypi/l/otripy)](https://github.com/kleag/otripy/blob/main/AGPL.md)
+[![Downloads](https://static.pepy.tech/badge/otripy/month)](https://pepy.tech/project/otripy)
+[![Supported Versions](https://img.shields.io/pypi/pyversions/otripy)](https://pypi.org/project/otripy)
+[![Contributors](https://img.shields.io/github/contributors/kleag/otripy)](https://github.com/kleag/otripy/graphs/contributors)
+
+<!--
+![Python Versions](https://img.shields.io/pypi/pyversions/otripy)
+![Build Status](https://img.shields.io/github/actions/workflow/status/kleag/otripy/ci.yml)
+-->
+
+## Description
+
+Otripy is a GUI application for trip planning, providing an intuitive user interface for organizing travel visits efficiently. Otripy allows to plan a trip by adding markers on a map (based on OpenStreetMap) associated with a note.
+
+Otripy is developed and daily tested on Linux. It should work on any platform. It has already been tested on MacOS.
+
+Otripy is already usable but would be better with a lot of other features. Some wanted features are listed [here](https://github.com/kleag/otripy/issues). Don't hesitate to create a new issue if you think at other features. And contribute them if you can!
+
+### Current features:
+
+* Display OpenStreetMap map
+* Zoom and pan the map
+* Adding location markers on the map
+* List existing location on the left part of the GUI
+* Associate a note to a location. The first line of the note is used as the title in the list
+* Search location by name, and add a new marker when selecting an entry in the list
+* Delete markers
+* Open and save local files
+* Open and save files on any Nextcloud server you have access to
+* Note text formatting (heading, bold, …)
+* Image insertion (copy paste only currently)
+
+## Screenshots
+
+![Otripy GUI snapshot](https://github.com/kleag/otripy/blob/main/pics/otripy-snapshot.png "Otripy GUI")
+
+## Installation
+
+### For users familiar with Python
+
+Otripy is on PyPi. To install it, run:
+
+```sh
+pip install otripy
+```
+
+### For all others
+
+If you are not used to installing Python packages, the simplest method is probably to use [uv](https://docs.astral.sh/uv/). Please [install it](https://docs.astral.sh/uv/getting-started/installation/) first. Then, open a terminal and create an uv virtual environment and activate it:
+
+
+```sh
+uv venv otripy
+source otripy/bin/activate
+```
+
+Then install Otripy and run it:
+
+```sh
+uv pip install otripy
+otripy
+```
+
+## Usage
+
+To launch the application:
+```bash
+otripy
+```
+
+## Building and publishing
+
+Otripy uses [uv](https://docs.astral.sh/uv/), please [install it](https://docs.astral.sh/uv/getting-started/installation/) if not already available.
+
+If you just cloned this repository, cd to it and then:
+
+```sh
+uv venv
+uv sync --all-extras
+uv pip install -r pyproject.toml --extra build
+install -d dist
+```
+
+Then, to build and publish:
+
+```sh
+rm dist/otripy-*
+bumpver update --patch # or --minor or --major
+uv build
+uv publish
+uv sync --all-extras
+git add uv.lock
+git commit -m "Update lock to new package version"
+```
+
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-name`).
+3. Commit changes (`git commit -m "Add feature"`).
+4. Push to your branch (`git push origin feature-name`).
+5. Open a pull request.
+
+## License
+This project is Free Software, licensed under the AGPL License. See the [AGPL](https://github.com/kleag/otripy/blob/main/AGPL.md) file for details. In summary: you can use it, share it, change it, redistribute your changes, but any version you offer, with or without changes must be under the same (or a compatible) license.
+
+## Credits
+Otripy is developed and maintained by [Kleag](https://github.com/kleag). Special thanks to all contributors!
+
+---
+
+For more information, visit the [GitHub repository](https://github.com/kleag/otripy) or the [PyPI page](https://pypi.org/project/otripy/).
+

otripy-1.0.0/pyproject.toml

@@ -0,0 +1,53 @@
+[project]
+name = "otripy"
+version = "1.0.0"
+description = "A tool to plan your next trip"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "folium>=0.19.5",
+    "geopy>=2.4.1",
+    "lxml>=5.3.1",
+    "markdown>=3.7",
+    "nc-py-api>=0.19.0",
+    "numpy>=2.2.3",
+    "pillow>=11.1.0",
+    "pyside6>=6.8.2.1",
+    "typing-extensions>=4.12.2",
+]
+authors = [{ name = "Gaël de Chalendar (aka Kleag)", email = "kleagg@gmail.com" }]
+license = { text = "AGPL" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+[tool.uv]
+package = true
+
+[project.scripts]
+otripy = "otripy.main:main"
+
+[project.optional-dependencies]
+dev = ["pytest", "black", "ruff", "mypy"]   # Development tools
+build = ["bumpver"]                   # For packaging and uploading
+deploy = ["uv"]                               # Add tools needed for deployment
+
+[bumpver]
+current_version = "1.0.0"
+version_pattern = "MAJOR.MINOR.PATCH"
+commit = true
+tag = true
+push = true  # Set to true if you want to push automatically
+
+[bumpver.file_patterns]
+"pyproject.toml" = [
+    'version = "{version}"',
+]
+"src/otripy/__init__.py" = [
+    '__version__ = "{version}"',
+]
+

otripy-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

otripy-1.0.0/src/otripy/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.0.0"

otripy-1.0.0/src/otripy/config.py

@@ -0,0 +1,84 @@
+from PySide6.QtGui import QAction
+from PySide6.QtWidgets import QApplication, QMainWindow, QDialog, QLabel, QLineEdit, QPushButton, QVBoxLayout, QMenuBar
+from PySide6.QtCore import QSettings
+
+
+class ConfigDialog(QDialog):
+    """Dialog for configuring Nextcloud settings"""
+    def __init__(self, settings, parent=None):
+        super().__init__(parent)
+        self.settings = settings
+        self.setWindowTitle("Configure Otripy")
+
+        # Create widgets
+        self.url_label = QLabel("Nextcloud URL:")
+        self.url_input = QLineEdit()
+
+        self.username_label = QLabel("Nextcloud Username:")
+        self.username_input = QLineEdit()
+
+        self.password_label = QLabel("Nextcloud Password:")
+        self.password_input = QLineEdit()
+        self.password_input.setEchoMode(QLineEdit.Password)  # Hide password
+
+        self.save_button = QPushButton("Save")
+        self.save_button.clicked.connect(self.save_settings)
+
+        # Layout
+        layout = QVBoxLayout()
+        layout.addWidget(self.url_label)
+        layout.addWidget(self.url_input)
+        layout.addWidget(self.username_label)
+        layout.addWidget(self.username_input)
+        layout.addWidget(self.password_label)
+        layout.addWidget(self.password_input)
+        layout.addWidget(self.save_button)
+        self.setLayout(layout)
+
+        # Load existing settings
+        self.load_settings()
+
+    def load_settings(self):
+        """Load settings from QSettings"""
+        self.url_input.setText(self.settings.value("nextcloud/url", ""))
+        self.username_input.setText(self.settings.value("nextcloud/username", ""))
+        self.password_input.setText(self.settings.value("nextcloud/password", ""))
+
+    def save_settings(self):
+        """Save settings to QSettings"""
+        self.settings.setValue("nextcloud/url", self.url_input.text())
+        self.settings.setValue("nextcloud/username", self.username_input.text())
+        self.settings.setValue("nextcloud/password", self.password_input.text())
+        self.accept()  # Close the dialog
+
+
+class MainWindow(QMainWindow):
+    """Main Application Window"""
+    def __init__(self):
+        super().__init__()
+        self.setWindowTitle("MyApp")
+        self.setGeometry(100, 100, 800, 600)
+
+        # QSettings initialization
+        self.settings = QSettings("Kleag", "Otripy")
+
+        # Menu bar
+        menubar = self.menuBar()
+        config_menu = menubar.addMenu("Configuration")
+
+        # Configuration action
+        config_action = QAction("Configure MyApp", self)
+        config_action.triggered.connect(self.open_config_dialog)
+        config_menu.addAction(config_action)
+
+    def open_config_dialog(self):
+        """Open the configuration dialog"""
+        dialog = ConfigDialog(self.settings, self)
+        dialog.exec()
+
+
+if __name__ == "__main__":
+    app = QApplication([])
+    window = MainWindow()
+    window.show()
+    app.exec()

otripy-1.0.0/src/otripy/journey.py

@@ -0,0 +1,58 @@
+from typing import List, Iterator
+
+try:
+    from .location import Location
+except ImportError:
+    from location import Location
+
+class Journey:
+    def __init__(self, locations: List[Location] = None):
+        """Initialize the journey with a list of Location objects."""
+        self._locations = locations if locations is not None else []
+
+    def __getitem__(self, index):
+        """Enable indexing and slicing."""
+        return self._locations[index]
+
+    def __setitem__(self, index, value: Location):
+        """Enable item assignment."""
+        if not isinstance(value, Location):
+            raise TypeError("Only Location instances can be added to the journey.")
+        self._locations[index] = value
+
+    def __delitem__(self, index):
+        """Enable item deletion."""
+        del self._locations[index]
+
+    def __iter__(self) -> Iterator[Location]:
+        """Enable iteration."""
+        return iter(self._locations)
+
+    def __len__(self) -> int:
+        """Return the number of locations in the journey."""
+        return len(self._locations)
+
+    def append(self, location: Location):
+        """Add a location to the journey."""
+        if not isinstance(location, Location):
+            raise TypeError("Only Location instances can be added to the journey.")
+        self._locations.append(location)
+
+    def insert(self, index: int, location: Location):
+        """Insert a location at a specific index."""
+        if not isinstance(location, Location):
+            raise TypeError("Only Location instances can be inserted into the journey.")
+        self._locations.insert(index, location)
+
+    def remove(self, location: Location):
+        """Remove a location from the journey."""
+        self._locations.remove(location)
+
+    def __repr__(self) -> str:
+        return f"Journey({self._locations})"
+
+    def loc_by_id(self, id: str) -> Location:
+        for loc in self:
+            if loc.id == id:
+                return loc
+        return None

otripy-1.0.0/src/otripy/location.py

@@ -0,0 +1,46 @@
+import logging
+import uuid
+
+from typing import Dict
+
+logger = logging.getLogger(__name__)
+
+class Location:
+    def __init__(self,
+                 lat: float = 0.0,
+                 lon: float = 0.0,
+                 note: Dict[str, str] = {"markdown": ""},
+                 id: str = str(uuid.uuid4())):
+        logger.info(f"Location({lat}, {lon}, {note}, {id})")
+        self.id = id
+        self.lat = lat
+        self.lon = lon
+        self.note = note
+
+    @classmethod
+    def from_data(cls, data: Dict[str, str | dict] = {}):
+        logger.info(f"Location.from_data({data})")
+        lat = float(data["lat"]) if "lat" in data else 0.0
+        lon = float(data["lon"]) if "lon" in data else 0.0
+        note = data["note"] if "note" in data else {"markdown": ""}
+        if type(note) is str:
+            note = {"markdown": note}
+        id = data["id"] if "id" in data else str(uuid.uuid4())
+        return cls(lat, lon, note, id)
+
+    def label(self):
+        return self.note["markdown"].split('\n')[0]
+
+    def to_html(self):
+        return self.note["markdown"].split('\n')[0].replace("\n", "<br>")
+
+    def location(self):
+        return [self.lat, self.lon]
+
+    def to_dict(self):
+        return {
+            "id": self.id,
+            "lat": self.lat,
+            "lon": self.lon,
+            "note": self.note
+            }