Normally skipole is imported into your code like any Python package, however, it also provides a useful feature when run directly.
To test this, run:
python3 -m skipole --version
Which should result in a string such as "3.0.0" being displayed.
You can now create a directory where projects will be developed, and a new project 'myproj'.
python3 -m skipole myproj /path/to/my/projectfiles
You should replace 'myproj' with your preferred name for a new project.
The /path/to/my/projectfiles should be to a directory where you will be developing your new project.
The projectfiles directory will be created with your new project 'myproj' within it:
As well as myproj, you will see two other projects automatically created:
skiadmin - a project used to help develop 'myproj'
'myproj' is an optional argument. If not given then only the skis and skiadmin projects will be created.
The path "/path/to/my/projectfiles" must be given, and is the path to a directory of your choice where you will develop your project. Multiple projects can be created in one 'projectfiles' directory, or you could have multiple such directories holding different projects.
If the directory already exists, any existing skiadmin and skis projects will be overwritten, this facility is used to upgrade skis and skiadmin if a new version of skipole is installed.
If myproj already exists in the directory, it will not be changed.
The myproj structure that has been created consists of the two directories ..myproj/data and ..myproj/static which the framework will need to know about. It saves JSON files defining the project under ..myproj/data. The code directory and file ..myproj/code/myproj.py could be located anywhere - however the generated myproj.py (which is a python file you will be developing further) assumes its own location, and so before changing anything you should understand how it works.
myproj.py is strongly commented so you should inspect it.