Skip to content

Commit

Permalink
Add metadata to pyproject.toml; bump version to 1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
will2dye4 committed Sep 14, 2023
1 parent fa7a4db commit d857565
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 24 deletions.
35 changes: 12 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,11 @@ tasks:

## Installation

The package is not currently available on PyPI or any other Python package repository. The easiest
way to install it is to clone the GitHub repository and install it from source.

### Prerequisites

* [Python](https://www.python.org/downloads/) 3.11 or newer
* [Git](https://git-scm.com)

### Dependencies

* The utility expects [`rsync`](https://linux.die.net/man/1/rsync) to be installed when importing
DJI video files. Modern distributions of Linux and macOS ship with `rsync` preinstalled, so you
likely do not need to install it separately. However, the version that is preinstalled on macOS
(as of macOS version 13.5) is an older version (2.x), and it is recommended to install `rsync`
version 3 or newer (using [Homebrew](https://brew.sh) or your preferred package manager) for the
best experience.

### Installation Instructions

Run the following commands in a shell (a UNIX-like environment is assumed):
The easiest way to install the package is to download it from [PyPI](https://pypi.org) using `pip`.
Run the following command in a shell (a UNIX-like environment is assumed):

```
$ git clone [email protected]:will2dye4/djiutil.git
$ cd djiutil
$ pip install .
$ pip install djiutil
```

The package does depend on a few external Python packages available on PyPI. If you wish to
Expand All @@ -47,6 +27,15 @@ utility to do so.
When successfully installed, a program called `djiutil` will be placed on your `PATH`. See the
Usage section below for details about how to use this program.

### Dependencies

* The utility expects [`rsync`](https://linux.die.net/man/1/rsync) to be installed when importing
DJI video files. Modern distributions of Linux and macOS ship with `rsync` preinstalled, so you
likely do not need to install it separately. However, the version that is preinstalled on macOS
(as of macOS version 13.5) is an older version (2.x), and it is recommended to install `rsync`
version 3 or newer (using [Homebrew](https://brew.sh) or your preferred package manager) for the
best experience.

## Usage

The `djiutil` program is a command-line interface for working with files created by DJI drones.
Expand Down
12 changes: 11 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,14 @@ build-backend = 'setuptools.build_meta'

[project]
name = 'djiutil'
version = '1.0.0'
version = '1.0.1'
description = 'Manipulate files created by DJI drones'
license = {file = 'LICENSE'}
readme = 'README.md'
authors = [
{name = 'William Dye'},
]
keywords = ['dji', 'dji air', 'dji drone', 'dji mavic', 'mavic', 'mavic pro']
dependencies = [
'srt ~= 3.5.3',
'tabulate ~= 0.9.0',
Expand All @@ -14,6 +21,9 @@ requires-python = '>=3.11'
[project.scripts]
djiutil = 'djiutil.__main__:main'

[project.urls]
Repository = 'https://github.com/will2dye4/djiutil.git'

[tool.setuptools.packages.find]
include = ['djiutil*']
namespaces = false

0 comments on commit d857565

Please sign in to comment.