Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update tests/README-DEV.md with developer usage details #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+94 −9
Open

docs: Update tests/README-DEV.md with developer usage details #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 44 additions & 4 deletions poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 12 additions & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ version="0.6.7"
authors=[{name="Ariel Frischer", email="[email protected]"}]
description="Generate bash/zsh/fish shell aliases automatically."
requires-python=">=3.6"
dependencies = [
"psutil>=5.9.0"
]
readme = "README.md"
classifiers=[
"Programming Language :: Python :: 3",
Expand Down Expand Up @@ -37,12 +40,12 @@ description = "Generate bash/zsh/fish shell aliases automatically."
authors=["Ariel Frischer <[email protected]>"]
maintainers=["Ariel Frischer <[email protected]>"]
readme = "README.md"
classifiers=[
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Operating System :: OS Independent"
]
keywords=[
keywords = [
"alias",
"bash",
"zsh",
Expand All @@ -54,9 +57,14 @@ keywords=[
"completion",
"abbr",
"generate",
"terminal",
"terminal"
]

[tool.poetry.dependencies]
python = ">=3.6"
psutil = ">=5.9.0"
chardet = ">=4.0.0"

[tool.poetry.scripts]
aliaser = "alias_gen.aliaser:main"

Expand Down
39 changes: 38 additions & 1 deletion tests/README-DEV.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,46 @@ twine upload -r testpypi dist/*
twine upload dist/*
```

## Test
## Testing Locally

### Running Tests
```bash
# Install development dependencies first
poetry install

# Run all tests
pytest .

# Run specific test file
pytest tests/test_aliaser.py

# Run tests with verbose output
pytest -v .

# Run tests with coverage report
pytest --cov=alias_gen tests/
```

### Running the Built Package Locally
After building the package with `poetry build`, you can:

1. Install and run from the wheel file:
```bash
# Install the wheel file
pip install dist/*.whl

# Run the installed executable
aliaser --help
```

2. Or run directly through poetry:
```bash
# Run the package through poetry
poetry run aliaser --help

# Or activate the poetry shell first
poetry shell
aliaser --help # Run commands in the poetry environment
```

## Bump version custom script usage
Expand Down