Metadata-Version: 2.1
Name: rhinopics
Version: 0.2.3
Summary: Rhinopics, let the fat unicorn rename yours pics!
Home-page: https://github.com/axelfahy/rhinopics
Download-URL: 
Author-email: Axel Fahy <axel@fahy.net>
Maintainer: Axel Fahy
Maintainer-email: Axel Fahy <axel@fahy.net>
License: MIT License
        
        Copyright (c) 2019 Axel Fahy
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/axelfahy/rhinopics
Project-URL: Repository, https://github.com/axelfahy/rhinopics
Project-URL: Issues, https://github.com/axelfahy/rhinopics/issues
Project-URL: Changelog, https://github.com/axelfahy/rhinopics/CHANGELOG.md
Keywords: pictures,photos,renaming
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click==8.1.7
Requires-Dist: click-pathlib==2020.3.13.0
Requires-Dist: exifread
Requires-Dist: ffmpeg-python==0.2.0
Requires-Dist: python-dateutil==2.9.0
Requires-Dist: tqdm==4.66.4

# rhinopics
> Rhinopics, let the fat unicorn rename your pics!

<p align="left">
    <a href="https://pypi.org/project/rhinopics/">
        <img src="https://img.shields.io/pypi/v/rhinopics.svg" alt="latest release" /></a>
    <a href="https://travis-ci.com/axelfahy/rhinopics">
        <img src="https://api.travis-ci.com/axelfahy/rhinopics.svg?branch=master" alt="Build Status" /></a>
    <a href="https://pypi.org/project/rhinopics/">
        <img src="https://img.shields.io/badge/python-3.6-blue.svg" alt="Python36" /></a>
</p>

Python CLI application to rename pictures.

The date of the pictures is retrieved from the metadata of the files and concatenate with a given word to create the new name.

Example of output: `word_20190621_001`

A number is added at the end in chronological order, the number of digits depends on the number of pictures having the same date or being in the folder.

## Installation

```sh
pip install rhinopics
```

## Usage example
Examples are available in the docstrings of the functions. Official documentation will soon come out, or not.

## Development setup

Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.

```sh
git clone https://github.com/axelfahy/rhinopics.git
cd rhinopics
python -m venv venv-dev
source venv-dev/bin/activate
pip install -r requirements_dev.txt
pip install -e .
```

## Tests

Soon to come.

```sh
python tests/test_rhinopics.py
```

## Release History

* 0.2.1
    * ADD: Default argument for the keyword is the name of the directory.
* 0.2.0
    * ADD: Flag to modify the extension to lowercase.
    * ADD: Add support for video files.
    * ADD: Restructuration of project.
    * ADD: Progress bar when renaming the files.
    * ADD: Logger
* 0.1.0
    * Initial release.

## Meta

Axel Fahy – axel@fahy.net

Distributed under the MIT license. See ``LICENSE`` for more information.

[https://github.com/axelfahy](https://github.com/axelfahy)

## Contributing

1. Fork it (<https://github.com/yourname/yourproject/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request

## Version number

The version of the package is link to the tag pushed.

To set a new version:

```sh
git tag v0.1.1
git push --tags
```

