Developer Notes

Building and Uploading the Package

To build the source distribution and wheel for ms-mint-app, follow these steps:

1. Navigate to the root directory of the project.
2. Run the following command to create the source distribution (sdist) and wheel (bdist_wheel):

python3 setup.py sdist bdist_wheel

This will generate distribution archives in the dist directory.

1. To upload the built package to the ms-mint repository, use twine. Ensure you have twine installed (pip install twine if not). Then, run:

python3 -m twine upload --repository ms-mint dist/ms*mint-*

This command will upload all matching distribution files to the specified repository.

Windows Executables

To create Windows executables for the ms-mint application, use pyinstaller. Follow these steps:

1. Navigate to the specfiles directory.
2. Run the pyinstaller command with the provided specification file:

cd specfiles && pyinstaller --noconfirm Mint.spec ..\scripts\Mint.py

This will generate a standalone executable for Windows based on the Mint.spec file.

Documentation Deployment

To build and deploy the documentation using mkdocs, follow these steps:

1. Ensure you have mkdocs installed (pip install mkdocs if not).
2. Run the following commands to build the documentation and deploy it to GitHub Pages:

mkdocs build && mkdocs gh-deploy

The mkdocs build command generates the static site in the site directory, and mkdocs gh-deploy pushes it to the gh-pages branch of your GitHub repository.

Example NGINX Configuration

To run ms-mint on a remote server, you need to set up a reverse proxy using NGINX. Here is an example configuration:

server {
    ...
    location / {
        proxy_pass              http://localhost:8000;
        client_max_body_size    100G;
        proxy_set_header        X-Forwarded-Proto https;
        proxy_set_header        Host $host;
    }
}

Explanation:

• proxy_pass http://localhost:8000;: Forwards all requests to the ms-mint application running on port 8000.
• client_max_body_size 100G;: Increases the maximum allowed size of client request bodies to 100GB.
• proxy_set_header X-Forwarded-Proto https;: Sets the X-Forwarded-Proto header to https.
• proxy_set_header Host $host;: Ensures the Host header from the original request is passed to the proxied server.

Then start ms-mint via the entrypoint.sh script.