Skip to content

Commit a5e334e

Browse files
P403n1x87P403n1x87
committed
Release v0.1.0 (#1)
Release v0.1.0
1 parent d14d242 commit a5e334e

21 files changed

Lines changed: 3449 additions & 2 deletions

‎.flake8‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[flake8]
2+
select = ANN,B,B9,C,D,E,F,W,I
3+
ignore = ANN101,B950,D100,D104,D107,D205,D212,D415,E203,E402,E501,F401,W503,W606
4+
max-line-length = 80
5+
docstring-convention = google
6+
import-order-style = google
7+
per-file-ignores =
8+
test/*:ANN,D
9+
noxfile.py:ANN,D

‎.github/FUNDING.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
github: p403n1x87
2+
patreon: P403n1x87
3+
custom: "https://www.buymeacoffee.com/Q9C1Hnm28"

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
### Description
2+
3+
[Description of the issue]
4+
5+
### Steps to Reproduce
6+
7+
1. [First Step]
8+
2. [Second Step]
9+
3. [and so on...]
10+
11+
**Expected behavior:** [What you expect to happen]
12+
13+
**Actual behavior:** [What actually happens]
14+
15+
**Reproduces how often:** [What percentage of the time does it reproduce?]
16+
17+
### Versions
18+
19+
Please provide the version of pytest-austin that you are using. Also, please
20+
include the OS and what version of the OS you're running.
21+
22+
### Additional Information
23+
24+
Any additional information, configuration or data that might be necessary to
25+
reproduce the issue.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
### Requirements for Adding, Changing, Fixing or Removing a Feature
2+
3+
Fill out the template below. Any pull request that does not include enough
4+
information to be reviewed in a timely manner may be closed at the maintainers'
5+
discretion.
6+
7+
8+
### Description of the Change
9+
10+
<!--
11+
12+
Please give a brief but exhaustive description of the changes contained in the
13+
PR.
14+
15+
-->
16+
17+
### Alternate Designs
18+
19+
<!-- Explain what other alternates were considered and why the proposed version
20+
was selected -->
21+
22+
### Regressions
23+
24+
<!-- What are the possible side-effects or negative impacts of the code change?
25+
Would any user of pytest-austin be forced to adapt their scripts or code if they
26+
wanted to upgrade to the new version? If so, please try to give an estimate of
27+
the effort involved.
28+
-->
29+
30+
### Verification Process
31+
32+
<!--
33+
34+
What process did you follow to verify that your change has the desired effects?
35+
36+
- How did you verify that all new functionality works as expected?
37+
- How did you verify that all changed functionality works as expected?
38+
- How did you verify that the change has not introduced any regressions?
39+
- How did you verify that the change has not introduced any memory leaks?
40+
41+
-->

‎.github/workflows/release.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Release
2+
on:
3+
release:
4+
types: [published]
5+
jobs:
6+
release:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v2
10+
- uses: actions/setup-python@v1
11+
with:
12+
python-version: '3.8'
13+
architecture: x64
14+
# - run: pip install nox==2020.5.24
15+
- run: pip install poetry==1.0.5
16+
# - run: nox
17+
- run: poetry build
18+
- run: poetry publish --username=__token__ --password=${{ secrets.PYPI_TOKEN }}

‎.github/workflows/tests.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Tests
2+
on: push
3+
jobs:
4+
tests:
5+
runs-on: ${{ matrix.os }}
6+
strategy:
7+
fail-fast: false
8+
matrix:
9+
os: [macos-latest, ubuntu-latest, windows-latest]
10+
name: Tests on ${{ matrix.os }}
11+
steps:
12+
- uses: actions/checkout@v2
13+
with:
14+
path: main
15+
16+
- uses: actions/setup-python@v2
17+
with:
18+
python-version: '3.x'
19+
architecture: x64
20+
21+
- name: Checkout Austin development branch
22+
uses: actions/checkout@master
23+
with:
24+
repository: P403n1x87/austin
25+
ref: devel
26+
path: austin
27+
28+
- name: Compile Austin on Linux
29+
run: |
30+
cd $GITHUB_WORKSPACE/austin
31+
gcc -Wall -O3 -Os -s -pthread src/*.c -o src/austin
32+
sudo setcap cap_sys_ptrace+ep src/austin
33+
if: startsWith(matrix.os, 'ubuntu')
34+
35+
- name: Compile Austin on Windows
36+
run: |
37+
cd $env:GITHUB_WORKSPACE/austin
38+
gcc.exe -O3 -o src/austin.exe src/*.c -lpsapi -Wall -Os -s
39+
if: startsWith(matrix.os, 'windows')
40+
41+
- name: Compile Austin on macOS
42+
run: |
43+
cd $GITHUB_WORKSPACE/austin
44+
gcc -Wall -O3 -Os src/*.c -o src/austin
45+
if: startsWith(matrix.os, 'macos')
46+
47+
- run: pip install nox==2020.5.24
48+
- run: pip install poetry==1.0.5
49+
50+
- name: Run nox on Linux
51+
run: |
52+
cd $GITHUB_WORKSPACE/main
53+
export PATH="$GITHUB_WORKSPACE/austin/src:$PATH"
54+
nox
55+
if: "startsWith(matrix.os, 'ubuntu')"
56+
57+
- name: Run nox on macOS
58+
run: |
59+
cd $GITHUB_WORKSPACE/main
60+
export PATH="$GITHUB_WORKSPACE/austin/src:$PATH"
61+
sudo nox
62+
if: startsWith(matrix.os, 'macos')
63+
64+
- name: Run nox on Windows
65+
run: |
66+
cd $env:GITHUB_WORKSPACE/main
67+
$env:PATH="$env:GITHUB_WORKSPACE/austin/src;$env:PATH"
68+
$env:PYTHONIOENCODING="utf8"
69+
nox
70+
if: "startsWith(matrix.os, 'windows')"
71+
72+
- name: Publish coverage metrics
73+
run: |
74+
cd $GITHUB_WORKSPACE/main
75+
nox -rs coverage
76+
if: startsWith(matrix.os, 'ubuntu')
77+
env:
78+
CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

‎.travis.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
language: python
2+
os: linux
3+
4+
git:
5+
depth: 1
6+
7+
osx_image: xcode10
8+
9+
dist: bionic
10+
11+
jobs:
12+
include:
13+
# Linux
14+
- env: TARGET=x86_64-unknown-linux-gnu
15+
os: linux
16+
17+
before_script:
18+
# Install required Python versions
19+
- sudo add-apt-repository ppa:deadsnakes/ppa -y
20+
- sudo apt-get install python3.{6..9} python3.{6..9}-dev -y;
21+
22+
# Clone Austin development branch
23+
- git clone --branch devel --depth 1 https://github.com/P403n1x87/austin.git ../austin
24+
25+
# Compile Austin and grant CAP_SYS_PTRACE capability
26+
- cd ../austin
27+
- gcc -Wall -O3 -Os -s -pthread src/*.c -o src/austin
28+
- sudo setcap cap_sys_ptrace+ep src/austin
29+
- cd -
30+
31+
- pip install nox==2020.5.24
32+
- pip install poetry==1.0.5
33+
34+
script:
35+
- export PATH="`realpath ../austin/src`:$PATH"
36+
- nox
37+
- nox -rs coverage

‎CODE-OF-CONDUCT.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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 [INSERT EMAIL ADDRESS]. 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

‎CONTRIBUTING.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to Austin
2+
3+
Thanks for taking the time to contribute or considering doing so.
4+
5+
The following is a set of guidelines for contributing to pytest-austin.
6+
7+
## Preamble
8+
9+
TBD
10+
11+
12+
## The Coding Style
13+
14+
TBD
15+
16+
17+
## Opening PRs
18+
19+
Everybody is more than welcome to open a PR to fix a bug/propose enhancements/
20+
implement missing features. If you do, please adhere to the following
21+
styleguides as much as possible.
22+
23+
24+
### Git Commit Messages
25+
26+
This styleguide is taken from the Atom project.
27+
28+
* Use the present tense ("Add feature" not "Added feature")
29+
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
30+
* Limit the first line to 72 characters or less
31+
* Reference issues and pull requests liberally after the first line
32+
33+
34+
### Labels
35+
36+
When opening a new PR, please apply a label to them. Try to use existing labels
37+
as much as possible and only create a new one if the current ones are not
38+
applicable.

0 commit comments

Comments
 (0)