{"id":20597440,"url":"https://github.com/loveduckie/search-pathfinding","last_synced_at":"2026-05-03T10:38:10.191Z","repository":{"id":259024479,"uuid":"876085009","full_name":"LoveDuckie/search-pathfinding","owner":"LoveDuckie","description":"A simple Python application for demonstrating breadth-first search and depth-first search for pathfinding.","archived":false,"fork":false,"pushed_at":"2024-10-21T13:02:16.000Z","size":46,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-26T15:46:02.361Z","etag":null,"topics":["bfs","dfs","pathfinding","python","python-tool","python-tools"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LoveDuckie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-21T11:26:38.000Z","updated_at":"2024-10-31T14:15:16.000Z","dependencies_parsed_at":"2024-10-22T15:40:59.987Z","dependency_job_id":null,"html_url":"https://github.com/LoveDuckie/search-pathfinding","commit_stats":null,"previous_names":["loveduckie/search-pathfinding"],"tags_count":0,"template":false,"template_full_name":"LoveDuckie/python-tool-template","purl":"pkg:github/LoveDuckie/search-pathfinding","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoveDuckie%2Fsearch-pathfinding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoveDuckie%2Fsearch-pathfinding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoveDuckie%2Fsearch-pathfinding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoveDuckie%2Fsearch-pathfinding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LoveDuckie","download_url":"https://codeload.github.com/LoveDuckie/search-pathfinding/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoveDuckie%2Fsearch-pathfinding/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32566444,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bfs","dfs","pathfinding","python","python-tool","python-tools"],"created_at":"2024-11-16T08:22:29.158Z","updated_at":"2026-05-03T10:38:10.173Z","avatar_url":"https://github.com/LoveDuckie.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python Tool Template\n\nThis repository is a template for creating Python tools with a consistent structure and standard features like linting, testing, and packaging.\n\n## Features\n\n- **Python Package Structure**: Includes a basic Python package setup (`search-pathfinding`).\n- **Testing Setup**: Example test files (`search-pathfinding_tests`) for unit testing.\n- **Development Tools**: Shell scripts to automate formatting, linting, testing (`run_format.sh`, `run_lint.sh`, `run_tests.sh`), and renaming (`rename.sh`).\n- **Project Configuration**: Uses `pyproject.toml` for dependency management with [Poetry](https://python-poetry.org/).\n\n## Getting Started\n\n### Prerequisites\n\n- Python 3.8+\n- [Poetry](https://python-poetry.org/) for dependency and project management\n\n\n### Dependencies\n\nThe project uses several dependencies defined in `pyproject.toml`. Below is a summary of the main dependencies and their purposes:\n\n- **[Poetry](https://python-poetry.org/)**: Used for dependency management and packaging.\n- **Linting and Formatting**: Includes tools like `pylint` and `black` to ensure code quality and consistency.\n- **Testing**: Uses `pytest` for unit testing to ensure the functionality of the code.\n\nTo install the dependencies, use:\n\n```sh\npoetry install\n```\n\n### Project Dependencies\n\nThis project relies on the following dependencies to ensure functionality, development efficiency, and maintainability:\n\n- **[rich](https://github.com/Textualize/rich)**: For rendering rich text, tables, and progress bars in the terminal, enhancing the user experience of the CLI.\n- **[rich-click](https://github.com/ewels/rich-click)**: Combines Rich and Click to add rich-text formatting and improve the usability of the command-line interface.\n- **[click](https://github.com/pallets/click)**: A framework for building flexible and easy-to-use command-line interfaces (CLI).\n\n### Development \u0026 Testing Dependencies\n\n- **[black](https://github.com/psf/black)**: Automatically formats code to ensure consistent style across the project.\n- **[pylint](https://github.com/PyCQA/pylint)**: Provides static code analysis to enforce coding standards and detect potential bugs.\n- **[coverage](https://github.com/nedbat/coveragepy)**: Measures the coverage of unit tests, helping to ensure all code paths are tested.\n\n### Documentation Dependencies\n\n- **[sphinx](https://www.sphinx-doc.org/)**: Generates project documentation in formats such as HTML and PDF.\n- **[sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme)**: Provides a clean, responsive theme for documentation, styled like Read the Docs.\n\nThese dependencies help streamline development, testing, and documentation while ensuring a user-friendly command-line interface.\n\n### Installation\n\n1. Clone the repository:\n\n    ```sh\n    git clone https://github.com/yourusername/search-pathfinding.git\n    cd search-pathfinding\n    ```\n\n2. Install the dependencies:\n\n    ```sh\n    poetry install\n    ```\n\n### Running the Tool\n\nTo run the main script:\n\n```sh\npoetry run python -m search-pathfinding\n```\n\n### Development\n\n#### Formatting\n\nTo format the codebase:\n\n```sh\n./run_format.sh\n```\n\n#### Linting\n\nTo lint the codebase:\n\n```sh\n./run_lint.sh\n```\n\n#### Testing\n\nTo run the tests:\n\n```sh\n./run_tests.sh\n```\n\n#### Renaming the Project\n\nTo rename the project (e.g., change the package name from `search-pathfinding` to something else):\n\n```sh\n./rename.sh new_project_name\n```\n\n### Project Structure\n\n- `search-pathfinding/`: The main package containing the tool's source code.\n- `search-pathfinding_tests/`: Contains unit tests for the package.\n- `.gitignore`: Specifies files and folders to be ignored by Git.\n- `pyproject.toml`: Project configuration and dependency management file.\n- `LICENSE`: The license for this project.\n\n### License\n\nThis project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file for details.\n\n### Contributing\n\nFeel free to open issues or submit pull requests for new features, bug fixes, or improvements.\n\n## Acknowledgements\n\nThis template is inspired by best practices for Python tool development, making it easy to start a new project with a consistent and productive setup.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floveduckie%2Fsearch-pathfinding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floveduckie%2Fsearch-pathfinding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floveduckie%2Fsearch-pathfinding/lists"}