{"id":28167677,"url":"https://github.com/slaclab/pydm-converter-tool","last_synced_at":"2025-07-14T01:02:12.612Z","repository":{"id":271951252,"uuid":"558537000","full_name":"slaclab/pydm-converter-tool","owner":"slaclab","description":"PyDM Converter (EDM to PyDM)","archived":false,"fork":false,"pushed_at":"2025-07-07T21:36:05.000Z","size":876,"stargazers_count":5,"open_issues_count":13,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-07T22:26:43.439Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://slaclab.github.io/pydm-converter-tool/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slaclab.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,"zenodo":null}},"created_at":"2022-10-27T18:45:29.000Z","updated_at":"2025-06-25T21:43:54.000Z","dependencies_parsed_at":"2025-01-11T00:32:57.664Z","dependency_job_id":"4971dd4c-657f-434c-817e-c4881237faaf","html_url":"https://github.com/slaclab/pydm-converter-tool","commit_stats":null,"previous_names":["slaclab/pydm-converter-tool"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/slaclab/pydm-converter-tool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fpydm-converter-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fpydm-converter-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fpydm-converter-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fpydm-converter-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slaclab","download_url":"https://codeload.github.com/slaclab/pydm-converter-tool/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fpydm-converter-tool/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265228803,"owners_count":23731083,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2025-05-15T14:13:17.524Z","updated_at":"2025-07-14T01:02:11.408Z","avatar_url":"https://github.com/slaclab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PyDM Converter\n\nPyDM Converter is an PyDM-based tool developed at SLAC National Accelerator Laboratory. PyDM Converter is an open-source project.\n\nFor more information and a how to guide on PyDM Converter see [the project's website](https://slaclab.github.io/pydm-converter-tool/)\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/slaclab/pydm-converter-tool/issues/new?labels=bug\u0026projects=\u0026template=bug-report.yml\u0026title=%5BBUG%5D+-+\"\u003eReport bug\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/slaclab/pydm-converter-tool/issues/new?labels=enhancement\u0026projects=\u0026template=feature-request.yml\u0026title=%5BFEATURE%5D+-+\"\u003eRequest feature\u003c/a\u003e\n\n\u003c/p\u003e\n\n## Contributing to PyDM Converter\n\nThank you for your interest in contributing to **PyDM Converter**! Your contributions help make the project better for everyone. Below are the guidelines to ensure a smooth and efficient collaboration.\n\n### How to Contribute\n\n1. **Fork and Clone the Repository**\n   - Fork the [PyDM Converter repository](https://github.com/slaclab/pydm-converter-tool) on GitHub.\n   - Clone your fork to your local machine:\n     ```bash\n     git clone https://github.com/your-username/pydm-converter-tool.git\n     cd pydm-converter-tool\n     ```\n\n2. **Set Up Your Development Environment**\n   - Install the necessary dependencies:\n     ```bash\n     pip install -r requirements.txt\n     ```\n\n3. **Implement Your Changes**\n   - **Code Style:** Follow the [PEP8](https://peps.python.org/pep-0008/) style guide for Python code.\n   - **Documentation:** Add docstrings to all new methods and classes using the [NumPy style guide](https://numpydoc.readthedocs.io/en/latest/format.html).\n   - **Unit Tests:** Write unit tests for your changes using [Pytest](https://docs.pytest.org/).\n\n4. **Run Tests Locally**\n   - Ensure all tests pass before submitting:\n     ```bash\n     pytest\n     ```\n\n5. **Create a Pull Request (PR)**\n   - When you feel like your feature is ready to be merged into the pydm converter make a PR and request feedback from the Maintainers.\n   - Provide a descriptive title and detailed description of your changes.\n\n### Pull Request Requirements\n\nTo ensure your PR is reviewed efficiently, please adhere to the following:\n\n- **Unit Tests:**\n  - Include tests for all new functionality.\n  - Ensure tests cover different scenarios and edge cases.\n\n- **Documentation:**\n  - All new methods and classes must have comprehensive docstrings.\n  - Follow the [NumPy style guide](https://numpydoc.readthedocs.io/en/latest/format.html) for consistency.\n\n- **Code Quality:**\n  - Adhere to the [PEP8](https://peps.python.org/pep-0008/) style guide.\n  - Ensure your code is clean, well-organized, and free of unnecessary complexity.\n\n### Additional Guidelines\n- **Communication:**\n  - For significant changes, consider opening an issue to discuss your approach before starting.\n\n### Resources\n\n- [NumPy Docstring Guide](https://numpydoc.readthedocs.io/en/latest/format.html)\n- [PEP8 Style Guide](https://peps.python.org/pep-0008/)\n- [Pytest Documentation](https://docs.pytest.org/)\n\n### Notes on Contributing to the Documentation\n\n1. **Set Up Your Development Environment**\n   - Ensure you are working on your development environment.\n\n2. **Navigate to the Project Directory**\n   - Go to the top-level `pydm-converter-tool` project directory, which contains the `mkdocs.yml` file.\n\n3. **Make and Test Your Changes Locally**\n   - Edit the documentation files as needed.\n   - Test your changes locally using MkDocs before submitting a pull request.\n\n---\n\n#### Detailed Steps\n\n1. **Set Up Your Development Environment**\n   - Make sure you have all the necessary tools installed (e.g., Python, MkDocs).\n\n2. **Navigate to the Project Directory**\n   ```bash\n   cd path/to/pydm-converter-tool\n\n3. **Install Dependencies**\n   ```bash\n    pip install -r requirements.txt\n\n4. **Serve the Documentation Locally**\n   ```bash\n    mkdocs serve\n\n-  Open your browser and go to http://localhost:8000 to preview your changes.\n\n5. **Submit Your Changes**\n\n- After verifying your changes, commit and push them to your forked repository.\n-  Create a pull request to submit your updates.\n\n---\n\nIf you have any questions or need further assistance, feel free to open an [issue](https://github.com/slaclab/pydm-converter-tool/issues) or reach out to the maintainers.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslaclab%2Fpydm-converter-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslaclab%2Fpydm-converter-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslaclab%2Fpydm-converter-tool/lists"}