A simple greeting package
Project description
greeting_package
greeting-package
is a Python package for greeting people.
Installation
You can install greeting-package
via pip
:
pip install greeting-package
Usage
from greeting_package.greeting import say_hello
say_hello('John') # 'Hello, John!'
say_hello('Jane') # 'Hello, Jane!'
Contributing
Bug reports and pull requests are welcome on GitHub at Here.
Documentation
The greeting-package documentation includes:
- Installation instructions
- Usage examples
- API reference
- Development instructions
API Reference
greeting_package.greeting.say_hello(name: str) -> str
Greet someone by name.
Parameters:
name (str): # The name of the person to greet.
Returns:
A greeting message (str).
Contributing
Bug Reports and Feature Requests
Please use the issue tracker to report any bugs or feature requests. Development
Clone the repository:
git clone https://github.com/osundwajeff/greeting_package.git
cd greeting-package
Create a virtual environment:
python3 -m venv env
source env/bin/activate
Install development dependencies:
pip install -r requirements-dev.txt
Make changes and add tests. Run the tests:
pytest tests/
Build the package:
python3 -m build
Install the package:
pip install .
Push your changes and create a pull request.
License
greeting-package is released under the MIT License. See LICENSE for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for greeting_package-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76cc12388c7a7ae8bdedcbfcae07334f39dbb0465966c98e62807e9054756721 |
|
MD5 | b5a453a1829fd290807f11f5a8cddf99 |
|
BLAKE2b-256 | 66db92561de4308edbe33bbc71c34d4f3041f057bb6a2c23b5a1d5b4d80a54f4 |