Skip to content

Commit 447577c

Browse files
timkpainetimkpaine
committed
init
1 parent 92cd69c commit 447577c

20 files changed

Lines changed: 938 additions & 2 deletions

‎.copier-answers.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: ea9f24b
3+
_src_path: https://github.com/python-project-templates/base.git
4+
add_extension: python
5+
email: dev@dau.dev
6+
github: dau-dev
7+
project_description: Python wrapping/binding for verible
8+
project_name: verible
9+
python_version_primary: '3.11'
10+
team: the verible-python authors

‎.gitattributes‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
examples/* linguist-documentation
2+
docs/* linguist-documentation
3+
*.ipynb linguist-documentation
4+
Makefile linguist-documentation
5+
6+
*.md text=auto eol=lf
7+
*.py text=auto eol=lf
8+
*.toml text=auto eol=lf
9+
*.yml text=auto eol=lf

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at 3105306+timkpaine@users.noreply.github.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/dependabot.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
labels:
8+
- "part: github_actions"
9+
10+
- package-ecosystem: "pip"
11+
directory: "/"
12+
schedule:
13+
interval: "monthly"
14+
labels:
15+
- "lang: python"
16+
- "part: dependencies"
17+

‎.github/workflows/build.yml‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: Build Status
2+
3+
on:
4+
push:
5+
branches: [main]
6+
tags: [v*]
7+
pull_request:
8+
branches: [main]
9+
workflow_dispatch:
10+
11+
concurrency:
12+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
13+
cancel-in-progress: true
14+
15+
permissions:
16+
contents: read
17+
checks: write
18+
pull-requests: write
19+
20+
jobs:
21+
build:
22+
runs-on: ${{ matrix.os }}
23+
strategy:
24+
matrix:
25+
os:
26+
- ubuntu-24.04
27+
- macos-14
28+
- windows-2022
29+
python-version:
30+
- "3.11"
31+
cibuildwheel:
32+
- "cp311"
33+
steps:
34+
- uses: actions/checkout@v4
35+
with:
36+
submodules: 'true'
37+
38+
- name: Setup cache (mac/linux)
39+
uses: actions/cache@v4
40+
with:
41+
path: "/home/runner/work/verible-python/verible-python/.ccache"
42+
key: cache-${{ runner.os }}-
43+
restore-keys: cache-${{ runner.os }}-
44+
if: ${{ runner.os != 'Windows' }}
45+
46+
- name: Setup cache (windows)
47+
uses: actions/cache@v4
48+
with:
49+
path: "C:/ProgramData/chocolatey/"
50+
key: cache-${{ runner.os }}-
51+
restore-keys: cache-${{ runner.os }}-
52+
if: ${{ runner.os == 'Windows' }}
53+
54+
- name: Set up Python ${{ matrix.python-version }}
55+
uses: actions/setup-python@v5
56+
with:
57+
python-version: ${{ matrix.python-version }}
58+
cache: 'pip'
59+
cache-dependency-path: 'pyproject.toml'
60+
61+
- name: Install dependencies
62+
run: pip install cibuildwheel
63+
64+
- name: Python Wheel Steps (linux)
65+
run: python -m cibuildwheel --output-dir dist
66+
env:
67+
CIBW_BUILD: "${{ matrix.cibuildwheel }}-manylinux*"
68+
CIBW_ENVIRONMENT_LINUX: CCACHE_DIR="/host/home/runner/work/verible-python/verible-python/.ccache"
69+
CIBW_BUILD_VERBOSITY: 3
70+
if: ${{ runner.os == 'Linux' }}
71+
72+
- name: Python Build Steps (mac)
73+
run: python -m cibuildwheel --output-dir dist
74+
env:
75+
CIBW_BUILD: "${{ matrix.cibuildwheel }}-macos*"
76+
CIBW_ENVIRONMENT_MACOS: CCACHE_DIR="/Users/runner/work/verible-python/verible-python/.ccache" MACOSX_DEPLOYMENT_TARGET=11.0
77+
CIBW_BUILD_VERBOSITY: 3
78+
if: ${{ matrix.os == 'macos-14' }}
79+
80+
- name: Python Build Steps (windows)
81+
run: python -m cibuildwheel --output-dir dist
82+
env:
83+
CIBW_BUILD: "${{ matrix.cibuildwheel }}-win_amd64"
84+
if: ${{ matrix.os == 'windows-2022' }}
85+
86+
- name: Upload Wheel
87+
uses: actions/upload-artifact@v4
88+
with:
89+
name: dist-${{ runner.os }}-${{ runner.arch }}-${{ matrix.python-version }}
90+
path: dist/*.whl
91+
92+
- name: Install wheel (mac/linux)
93+
run: python -m pip install dist/*.whl
94+
if: ${{ runner.os != 'Windows' }}
95+
96+
- name: Install wheel (windows)
97+
run: python -m pip install -U (Get-ChildItem .\dist\*.whl | Select-Object -Expand FullName)
98+
if: ${{ runner.os == 'Windows' }}
99+
100+
- name: Install test dependencies
101+
run: python -m pip install pytest rich typer
102+
103+
- name: Test Wheel
104+
run: python -m pytest -vvv verible/tests

‎.github/workflows/copier.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Copier Updates
2+
3+
on:
4+
workflow_dispatch:
5+
schedule:
6+
- cron: "0 5 * * 0"
7+
8+
jobs:
9+
update:
10+
permissions:
11+
contents: write
12+
pull-requests: write
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions-ext/copier-update@main
16+
with:
17+
token: ${{ secrets.WORKFLOW_TOKEN }}

0 commit comments

Comments
 (0)