diff --git a/.copier-answers.yml b/.copier-answers.yml index aaf35b9..0875790 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,7 +1,9 @@ # Changes here will be overwritten by Copier -_commit: ea9f24b +_commit: 19e0124 _src_path: https://github.com/python-project-templates/base.git +add_docs: false add_extension: python +add_wiki: false email: dev@dau.dev github: dau-dev project_description: Python wrapping/binding for verible diff --git a/.gitattributes b/.gitattributes index 7c39058..b40d312 100644 --- a/.gitattributes +++ b/.gitattributes @@ -6,4 +6,4 @@ Makefile linguist-documentation *.md text=auto eol=lf *.py text=auto eol=lf *.toml text=auto eol=lf -*.yml text=auto eol=lf +*.yaml text=auto eol=lf diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..fac2920 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,29 @@ --- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' +name: Bug Report +about: Report a bug to help us improve +title: '[BUG] ' +labels: 'type: bug' assignees: '' - --- -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +**Description** +A clear and concise description of the bug. -**Expected behavior** -A clear and concise description of what you expected to happen. +**Steps to Reproduce** +1. +2. +3. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Expected Behavior** +What you expected to happen. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +**Actual Behavior** +What actually happened. Include full error messages or tracebacks if available. -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +**Environment** +- OS: [e.g. Ubuntu 22.04, macOS 14.0, Windows 11] +- Python version: [e.g. 3.11.5] (`python --version`) +- Package version: (`pip show verible | grep Version`) -**Additional context** -Add any other context about the problem here. +**Additional Context** +Add any other relevant context, logs, or screenshots. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..c3e422e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,19 @@ --- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' +name: Feature Request +about: Suggest a new feature or improvement +title: '[FEATURE] ' +labels: 'type: enhancement' assignees: '' - --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**Problem Statement** +A clear description of the problem this feature would solve. Ex. "I'm always frustrated when [...]" -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +**Proposed Solution** +A clear description of the desired behavior or feature. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**Alternatives Considered** +Any alternative solutions or workarounds you've considered. -**Additional context** -Add any other context or screenshots about the feature request here. +**Additional Context** +Add any other context, mockups, or examples. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..ca52f7e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,16 @@ +--- +name: Question +about: Ask a question about usage or behavior +title: '[QUESTION] ' +labels: 'tag: question' +assignees: '' +--- + +**Question** +A clear and concise description of your question. + +**Context** +What are you trying to accomplish? Include relevant code snippets, configuration, or links to documentation you've already consulted. + +**Environment** +If relevant, include your environment details (OS, language versions, package version). diff --git a/.github/dependabot.yml b/.github/dependabot.yaml similarity index 82% rename from .github/dependabot.yml rename to .github/dependabot.yaml index ec9feaa..0961ae8 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yaml @@ -3,7 +3,7 @@ updates: - package-ecosystem: "github-actions" directory: "/" schedule: - interval: "weekly" + interval: "monthly" labels: - "part: github_actions" @@ -11,7 +11,8 @@ updates: directory: "/" schedule: interval: "monthly" + cooldown: + default-days: 7 labels: - "lang: python" - "part: dependencies" - diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..35c3de1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ +## Description + +Brief description of the changes in this PR. + +## Type of Change + +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation update +- [ ] Refactor / code cleanup +- [ ] CI / build configuration +- [ ] Other (describe below) + +## Checklist + +- [ ] Linting passes (`make lint`) +- [ ] Tests pass (`make test`) +- [ ] New tests added for new functionality +- [ ] Documentation updated (if applicable) +- [ ] Changelog / version bump (if applicable) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yaml similarity index 100% rename from .github/workflows/build.yml rename to .github/workflows/build.yaml diff --git a/.github/workflows/copier.yml b/.github/workflows/copier.yaml similarity index 100% rename from .github/workflows/copier.yml rename to .github/workflows/copier.yaml diff --git a/.gitignore b/.gitignore index 34240a8..6adad27 100644 --- a/.gitignore +++ b/.gitignore @@ -4,11 +4,21 @@ __pycache__/ *$py.class # C extensions +*.a +*.o +*.dSYM *.so *.a *.o *.d +*.obj *.dll +*.exp +*.lib + +# Rust +target +target-capi # Distribution / packaging .Python @@ -32,8 +42,6 @@ share/python-wheels/ 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 @@ -56,26 +64,12 @@ junit.xml .hypothesis/ .pytest_cache/ -# Translations -*.mo -*.pot - -# Django stuff: +# Django *.log local_settings.py db.sqlite3 db.sqlite3-journal -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# PyBuilder -target/ - # IPython profile_default/ ipython_config.py @@ -84,21 +78,14 @@ ipython_config.py .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 +Pipfile.lock -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff +# Celery celerybeat-schedule celerybeat.pid -# SageMath parsed files -*.sage.py +# Airspeed Velocity +.asv # Environments .env @@ -128,23 +115,50 @@ dmypy.json .pyre/ # Documentation -docs/_build/ /site +index.md +docs/_build/ docs/api +docs/html docs/index.md -_template/labextension +docs/jupyter_execute +docs/src/_build/ +docs/superpowers +index.md + +# JS +js/coverage +js/dist +js/lib +js/node_modules +js/test-results +js/playwright-report +js/*.tgz # Jupyter .ipynb_checkpoints .autoversion +Untitled*.ipynb +verilator/extension +verilator/nbextension +verilator/labextension + +# Emscripten SDK (locally installed) +emsdk # Mac .DS_Store -# Rust -target +# Hydra +outputs/ +multirun/ + +# AI +ROADMAP.md +AGENTS.md +.github/hooks/sdlc.json +.superpowers # Verible verible/bin/ logs - diff --git a/LICENSE b/LICENSE index 261eeb9..3aaae5e 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright 2026 the verible-python authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/Makefile b/Makefile index 6ce86ba..d9f17df 100644 --- a/Makefile +++ b/Makefile @@ -56,7 +56,7 @@ lint-py: ## lint python with ruff lint-docs: ## lint docs with mdformat and codespell python -m mdformat --check README.md - python -m codespell_lib README.md + python -m codespell_lib README.md fix-py: ## autoformat python code with ruff python -m ruff check --fix verible diff --git a/README.md b/README.md index 2e73b65..f49e253 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Python wrapping/binding for verible -[![Build Status](https://github.com/dau-dev/verible-python/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/dau-dev/verible-python/actions/workflows/build.yml) +[![Build Status](https://github.com/dau-dev/verible-python/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/dau-dev/verible-python/actions/workflows/build.yaml) [![codecov](https://codecov.io/gh/dau-dev/verible-python/branch/main/graph/badge.svg)](https://codecov.io/gh/dau-dev/verible-python) [![License](https://img.shields.io/github/license/dau-dev/verible-python)](https://github.com/dau-dev/verible-python) [![PyPI](https://img.shields.io/pypi/v/verible.svg)](https://pypi.python.org/pypi/verible) @@ -40,3 +40,6 @@ verible-cli verible-verilog-ls This software is licensed under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details. Verible is Copyright 2019-2024 Google LLC, licensed under the Apache 2.0 license. + +> [!NOTE] +> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base). diff --git a/setup.py b/setup.py deleted file mode 100644 index aefdf20..0000000 --- a/setup.py +++ /dev/null @@ -1 +0,0 @@ -__import__("setuptools").setup()