Metadata-Version: 2.1
Name: pixboards
Version: 0.2.25
Description-Content-Type: text/markdown
Requires-Dist: Jinja2
Requires-Dist: psycopg2-binary
Requires-Dist: python-dotenv
Requires-Dist: PyYAML
Requires-Dist: Requests
Requires-Dist: setuptools
Requires-Dist: dotenv

# notice

repo finally changed to [https://github.com/flynnsharwood/pixBoards.git](https://github.com/flynnsharwood/pixBoards.git)

Gui has not been set up yet. Don't try to run the gui.py

title and heading use the board name now. favicon added, can be changed, check the templates folder. 

~~if you are using the PyPi package, you will need to have a running postgres server, else it won't work.~~ It works now. 

# pixBoards

pixBoards is a python library to help you organise your images and videos into masonry-containers (the pinterest layout)

It outputs simple html files with links to the images. Simplicity was the aim here, so don't expect fancy stuff in it.

It organises the images into "boards" which can be nested inside other boards. (Just think of them as a folder for now)

You can also automatically upload the files to imgchest and use those links in the output html files. You can then simply host these output files and you will have a working webpage. (If you had to use local files, you'd have to host the images too, which would be a pain in) (use --upload for that)

you can also use lists of imagelinks to create boards.

I also recently added the ability to use links in sidecarfiles to use as upload links instead of uploading the image to imgchest. (if you used a bulk downloader like gallery-dl, you'd be able to easily create such sidecar files every time you download.)

### screenshots

example of index file
![https://cdn.imgchest.com/files/4apc5px5gv4.png](https://cdn.imgchest.com/files/4apc5px5gv4.png)

example of image board
![https://cdn.imgchest.com/files/yrgcnjaxew4.png](https://cdn.imgchest.com/files/yrgcnjaxew4.png)

## how to use 

first, rename the config_example.yml to config.yml. or start afresh, your choice.

if you wish to upload to imgchest and use those links instead, use `--upload`

If it is the first time you are uploading, you will have to install postgresql first if not already installed. 


### install

you can install the pixBoards package from PyPi

`pip install pixBoards`

or clone the repo.

`git clone https://github.com/flynnsharwood/boards_v2.git`

### First time upload
If it is the first time you are uploading, you will have to install postgresql first if not already installed. 

Also, if you have a LOT of files to upload for the first time, go to the uploader folder. [repo link](https://github.com/flynnsharwood/imgUploader)

1. set up the directories list in config.yml
1. run listFiles.py. it will create a file named "MediaFiles.py"
2. now run calc_hex.py
3. run fileListUpload.py

fileListUpload basically uploads in batches of 20, unlike the original script where it uploads each image individually. This will upload and cache the links and hashes to postgress db

### Usage
simply use the binary file provided `boards.exe` 

Or do `python3 cli.py` or `python3 __main__.py`

flags you might use

`--upload` ensure all files are being uploaded. If you have pictures with the same filenames in different folders, you might need to fix this.

`--gitPush` this will push your created html files to a github repo. set up your repo to trigger a gh_pages deployment every push.

`--config` change the config file being used


here is a link to an example board - [https://flynnsharwood.github.io/exampleBoard/index.html](https://flynnsharwood.github.io/exampleBoard/index.html) 

---
## features

added an button to load a random page in 0.2.18


---

