Skip to content

Commit

Permalink
Renamed CONTRIBUTING to DEVELOPING
Browse files Browse the repository at this point in the history
  • Loading branch information
Dawson R committed Sep 10, 2024
1 parent 4f1d5f1 commit 9df5410
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 37 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.md → DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ This project uses [Poetry](https://python-poetry.org/) for dependency management

1. Install Poetry if you haven't already:

```bash
curl -sSL https://install.python-poetry.org | python3 -
```
```bash
curl -sSL https://install.python-poetry.org | python3 -
```

2. Install the project dependencies:

```bash
poetry install
```
```bash
poetry install
```

## Building the Package

Expand All @@ -34,14 +34,14 @@ To publish the package to PyPI, follow these steps:

1. Ensure you have a valid PyPI account and have configured your credentials using Poetry:

```bash
poetry config pypi-token.pypi <your-token>
```
```bash
poetry config pypi-token.pypi <your-token>
```

2. Publish the package:

```bash
poetry publish
```
```bash
poetry publish --build
```

This will upload the package to PyPI, making it available for others to install.
33 changes: 8 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
Click support for Pendulum date, time, interval and duration types to allow
developers to easily parse strings as parameters to Python click CLIs.

## Example: `pendulum.DateTime`
```bash
pip install click-pendulum
```

## Examples

### `pendulum.DateTime`

You can accept a Pendulum DateTime as a parameter to your click CLI

Expand All @@ -30,7 +36,7 @@ $ python examples/datetime_with_custom_format.py --date=2016-01-01
The date : 2016-01-01 00:00:00+00:00
```

## Example: `pendulum.Duration`
### `pendulum.Duration`

You can accept a Pendulum Duration as a parameter to your click CLI

Expand All @@ -56,29 +62,6 @@ $ python examples/duration_parser.py --duration="2d5h"
Duration: 2 days 5 hours
```

```bash
pip install click-pendulum
```

## Development

### Building and packaging

```bash
poetry build
```

### Testing the compiled wheel

```bash
# Create a virtual environment for testing
python -m .venv/test
source .venv/test/bin/activate

# Confirm importing and exporting is correct
python -c 'import click_pendulum as cd; print(dir(cd))'
```

## Authors

- Dawson Reid (@ddaws)

0 comments on commit 9df5410

Please sign in to comment.