AIDesign-Blend

AIDesign image fragments blending application.

Installation (Using `pip`)

Go to the root directory of this repository.
If you are using GUI, open a command line window in the directory.
Run the pip install -r ./requirement.txt command. This will install the dependencies.
See below. Choose your installation type and follow the instructions.

Editable Mode Installation

Run the pip install -e ./ command. This will install the application under the editable mode.
If you change the source code, you do not need to reinstall the package to reflect the changes.

Deployment Mode Installation (Temporarily Unavailable)

~~Run the pip install ./ command. This will install the application.~~
~~If you need to update the app or change the code, you will need to reinstall the package.~~

Usage (From Command Line Shell)

blend: The main command, which provides you the access to all the subcommands of the app.

blend help: The help subcommand, which tells you the details about how to use the app.

`blend help` Help Page

> blend help
Usage: blend <command> ...
==== Commands ====
help:
    When:   You need help info. For example, now.
    How-to: blend help
info:
    When:   You need package info.
    How-to: blend info
create:
    When:   You create a new blend project with the defaults.
    How-to: blend create <path-to-project>
status:
    When:   You check the application status.
    How-to: blend status
project:
    When:   You select the blend project for the next session.
    How-to: blend project <path-to-project>
frags:
    When:   You select the folder of fragments for the next session.
    How-to: blend frags <path-to-frags>
start:
    When:   You start a session.
    How-to: blend start
    Notes:  You will be prompted with the command status. You need to confirm to continue.
reset:
    When:   You want to reset the app data.
    How-to: blend reset
    Notes:  You will lose the current app data after the reset.

Dependencies

See <this-repo>/requirements.txt.

Testing

You can test this application by running python <this-repo>/test_all.py.

Python Code Style

Follows PEP8 with the exceptions shown in the following VSCode settings.json code fragment.

{
  ...,
  "python.formatting.provider": "autopep8",
  "python.formatting.autopep8Args": [
    "--max-line-length=119"
  ],
  "python.linting.enabled": true,
  "python.linting.pycodestyleEnabled": true,
  "python.linting.pycodestyleArgs": [
    "--max-line-length=119"
  ],
  ...
}

Other `README` Files

Other README.* files in this repository are listed below.

Blend project README

Miscellaneous

Developer's Notes 📝 And Warnings ⚠️

Notes 📝

This application is distributed under the GNU GPL3 license.

A subsequent work of this application is a work that satisfies any one of the following:

Is a variant of any form of this application.
Contains a part, some parts, or all parts of this application.
Integrates a part, some parts, or all parts of this application.

All subsequent works of this application must also be distributed under the GNU GPL3 license, and must also open their source codes to the public.

An output of this application is a file that satisfies all of the following:

Is directly produced by running one or more commands provided by this application.
Is directly produced by conducting one or more operations on the GUI of this application.

The outputs of this application do not have to be distributed under the GNU GPL3 license.

The non-subsequent works that uses the outputs of this application do not have to be distributed under the GNU GPL3 license.

Warnings ⚠️

Making a closed-source subsequent work (as defined above) of this application, and distribute it to the public is unlawful, no matter if such work makes a profit.

Doing the above may result in severe civil and criminal penalties.

I reserve the rights, funds, time, and efforts to prosecute those who violate the license of this application to the maximum extent under applicable laws.

Versions

Versioning

The versioning of this application is based on Semantic Versioning.
You can see the complete Semantic Versioning specification from
  https://semver.org/.
Basically, the version name of this application is in the form of:
  x.y.z
  Where x, y, and z are integers that are greater than or equal to 0.
  Where x, y, and z are separated by dots.
  x stands for the major version and indicates non-compatible major changes to
    the application.
  y stands for the minor version and indicates forward compatible minor
    changes to the application.
  z stands for the patch version and indicates bug fixes and patches to the
    application.

Version Tags

The version tags of this repository has the form of a letter "v" followed by a
  semantic version.
Given a semantic version:
  $x.$y.$z
  Where $x, $y, and $z are the semantic major, minor, and patch versions.
The corresponding version tag would be:
  v$x.$y.$z
The version tags are on the main branch.

Copyright

Short Version

Copyright (C) 2022 Yucheng Liu. GNU GPL3 license (GNU General Public License
  Version 3).
You should have and keep a copy of the above license. If not, please get it
  from https://www.gnu.org/licenses/gpl-3.0.txt.

Long Version

AIDesign-Blend, AIDesign image fragments blending application.
Copyright (C) 2022 Yucheng Liu. GNU GPL3 license (GNU General Public License
  Version 3).

This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free
  Software Foundation, either version 3 of the License, or (at your option)
  any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  more details.

You should have received a copy of the GNU General Public License along with
  this program. If not, see:
  1. The LICENSE file in this repository.
  2. https://www.gnu.org/licenses/#GPL.
  3. https://www.gnu.org/licenses/gpl-3.0.txt.

liu-yucheng/AIDesign-Blend