Key Features • How To Use • Contributing • Credits • Authors • License • Projects using autophoto • Changelog
- Publish photos (or images) to a remote server
- Only supports Bluesky
- Randomly select 4 photos and publish them
- Pre-scan your directories for photos
- Photos are detected by a path pattern
- Check all detected photos if they are valid (for instance BlueSky has size limitations)
- Scan your directory for photos
- For now only suppose to work with video game screenshots
- Photos are detected by a path pattern
- Save them into a file database
- Publish database statistics
- Application is build as native desktop app
- CLI based
Find the latest release here. Download the latest release for your platform and run the executable.
Read the following instructions to use it with command lines.
First, you need to configure the application to scan your directory for photos with a YAML configuration file.
Example configuration file:
autophoto:
scan:
- directory: ./test/resources/video-game
type: video-game
data-pattern:
regex: '^(.+) \((\d{4})\)/(.+)/.+\.webp$'
groups:
- title
- release-year
- platformAs you can scan multiple directories, you can add multiple scan entries.
A scan entry has the following properties:
directory: The directory to scan for photostype: The type of photos to scan for (V1 only supportsvideo-game)data-pattern: The pattern to extract data from the photo pathregex: The regex to match the photo pathgroups: The groups to extract from the regex (only the following groups are supported for now:title,release-year,platform)
In the example above, the application will scan the ./test/resources/video-game directory for photos with the following path pattern:
{video game title} ({release-year})/{platform}/photo-name.webp
Once you have your configuration file, you can run the application with the configuration file as argument: :
autophoto --prescan=./path/to/your/configuration-file.yamlYou'll see the detected photos and if they are valid or not in the console.
Once you have your configuration file, you can run the application with the configuration file as argument: :
autophoto --scan=./path/to/your/configuration-file.yamlThe scanned data are stored in a SQLite database in the db.autophoto.sqlite3 file.
You need a Bluesky account to publish your photos: Bluesky.
Then run the application with the --publish option and your mandatory Bluesky credentials:
autophoto --publish --bluesky_login=your_login --bluesky_password=your_passwordOptionnally, you can also specify the Bluesky URL with the --bluesky_host option:
autophoto --publish --bluesky_login=your_login --bluesky_password=your_password --bluesky_host=https://bsky.appYou need a Bluesky account to publish statistics: Bluesky.
Then run the application with the --stats option and your mandatory Bluesky credentials:
autophoto --stats --bluesky_login=your_login --bluesky_password=your_passwordOptionnally, you can also specify the Bluesky URL with the --bluesky_host option:
autophoto --stats --bluesky_login=your_login --bluesky_password=your_password --bluesky_host=https://bsky.appFor all actions (pre-scan, publish scan or stats), you can set other options in the command line.
You can specify the path to the database file with the --database option:
autophoto --scan=./path/to/your/configuration-file.yaml --database=./path/to/your/database-file.sqlite3This option is not used for the pre-scan action.
You also activate the debug mode with the --debug option:
- When scanning, this will print the video games and photos detected.
- When pusblishing, this will print the photos published.
Example:
autophoto --publish --bluesky_login=your_login --bluesky_password=your_password --debugYou can change the logger style with the --logger option:
autophoto --scan=./path/to/your/configuration-file.yaml --logger=batchThe following styles are available:
batch: print only the essential and raw informationconsole: print all the information with style and colors
console is the default style.
Deno is a runtime for JavaScript and TypeScript that is based on the V8 JavaScript engine and the Rust programming language.
You need to install Deno to run the project: https://docs.deno.com/runtime/getting_started/installation/.
Activate the linter and formater with Biome:
deno add npm:@biomejs/biome@1.9.4
deno install --allow-scripts=npm:@biomejs/biome@1.9.4You'll be able to run the lint with the following command (Deno linter and Biome linter will be executed):
deno task lintYou'll be able to run the format with the following command (only use Biome formatter):
deno task formatYou can install the git hooks with the following command:
deno task hook installIt will run the linter and tests before each commit.
You can execute a scan with the following command:
deno task e2e:prescanYou can execute a scan with the following command:
deno task e2e:scanIt will use the configuration files config.yml and ./test/resources/config2.yml, and create a local database ./test/e2e-debug.sqlite3.
Careful this section will publish a message on a real Bluesky account!
There is a small debug database in this project (created with the previous paragraph Run the scanner). If you want to publish a statistics message, follow these instructions. Be sure to have your Bluesky credentials (email and password).
You can execute a publication with the following command:
LOGIN=your_login PASSWORD=your_password deno task e2e:publishCareful this section will publish a message on a real Bluesky account!
There is a small debug database in this project (created with the previous paragraph Run the scanner). If you want to publish a statistics message, follow these instructions. Be sure to have your Bluesky credentials (email and password).
You can check a real execution with the following command line:
LOGIN=your_login PASSWORD=your_password deno task e2e:statsYou can run the unit tests with the following command:
deno task testYou can run the coverage with the following command:
deno task coverageIt will generate a coverage report in the coverage directory and open it in your browser.
You can optionnally create an issue to describe a new feature, a bug or something else.
Then create a Pull Request (see non existing yet CONTRIBUTING.md file).
This software uses the following open source packages:
- JavaScript runtime: Deno 2
- Lint and format: Biome
- JavaScript Standards: jsr.io
- To publish on Bluesky: atproto - For Bluesky
- Multiformats library: Multiformats
- Git hook: Hook
- Diagrams: Chart.js
- README template by Amit Merchant
- I wish to not generate a header with IA so I used an image by eniko kis on Unsplash
- Thomas Cicognani - Original creator - Zhykos
- Andrea Valentini - Contributor - AndreVale69
This project is also a space to learn and experiment with Deno, TypeScript, DDD and TDD. So, if you have any suggestions, questions or want to chat, feel free to contact me. Some things already need to be improved, like the error handling, the architecture, the domains, the performance, etc. So, if you want to help me, I will be happy to work with you.
If you need to update the database or something else, some scripts exist because the application does not support some features yet.
You can find those scripts in the scripts directory:
setPublished.tsupdates thepublishedproperty of an image: set a video game name and all its images will be set as published
To use a script, run this command (replace xxx.ts with an actual name):
cd scripts
deno run --allow-all --unstable-kv xxx.ts- 1.0.0
- Initial release
- Forgot to add the changelog
- 2.1.0
- Remove the pick priority of directories which have at least 4 photos to publish
- 2.2.0
- Fix number formats in logs (thanks to @AndreVale69)
- Add a logger style option (batch or console)
- Check PRs with GitHub Actions
- 2.3.0
- Add "PlayStation 4 (demo)" platform
- 2.4.0
- Add "Xbox One (beta)" platform
- New CLI option to publish statistics
- 2.5.0
- Add "Nintendo Switch (demo)" platform
- Diagrams for statistics
- 2.6.0
- Add some scripts to update the database