folderbrowser 0.1.4

Lightweight webserver to browse folder and its contents on a webbrowser

Description

Generate webpages for browsing a folder via the web. Can act as a stand-alone webserver, or in future embeddable in another application.

Installation

This package is registered on the Python Package Index (PyPI) as folderbrowser.

Install it with

$ poetry install folderbrowser

or

$ pip install folderbrowser

Running

$ python -m folderbrowser

This prints something like

2021-01-16 21:36:11,279 INFO: Server URL: http://127.0.0.1:8080/

You can then browse the contents of the invocation directory via the URL shown.

Development and Testing

Quickstart

$ git clone https://github.com/wbjrpub/folderbrowser.git
$ cd folderbrowser
$ poetry install

Run each command below in a separate terminal window:

$ make watch

Primary development tasks are defined in the Makefile.

Source Code

The source code is hosted on GitHub. Clone the project with

$ git clone https://github.com/wbjrpub/folderbrowser.git

Requirements

You will need Python 3 and Poetry.

Install the development dependencies with

$ poetry install

Tests

Lint code with

$ make lint

Run tests with

$ make test

Run tests on changes with

$ make watch

Publishing

High Level:

• Choose a new version nr (increment major, minor, or patch)

• Add to CHANGELOG.md!

• make all

• commit

• git push origin HEAD:master

• Check Github Actions: https://github.com/wbjrpub/folderbrowser/actions?query=workflow%3Amain

• bump2version major|minor|patch

• git push origin HEAD:master && git push –tags origin vX.Y.Z

• Check Github Actions: https://github.com/wbjrpub/folderbrowser/actions?query=workflow%3Apublish

Use the bump2version command to release a new version (with argument major, minor, or patch). Push the created git tag which will trigger a GitHub action.

Publishing may be triggered using on the web using a workflow_dispatch on GitHub Actions.

GitHub Actions

GitHub Actions should already be configured: this section is for reference only.

The following repository secrets must be set on GitHub Actions.

• PYPI_API_TOKEN: API token for publishing on PyPI.

These must be set manually.

Secrets for Optional GitHub Actions

The version and format GitHub actions require a user with write access to the repository including access to read and write packages. Set these additional secrets to enable the action:

• GH_USER: The GitHub user’s username.

• GH_TOKEN: A personal access token for the user.

• GIT_USER_NAME: The name to set for Git commits.

• GIT_USER_EMAIL: The email to set for Git commits.

• GPG_PRIVATE_KEY: The GPG private key.

• GPG_PASSPHRASE: The GPG key passphrase.

Contributing

Please submit and comment on bug reports and feature requests.

To submit a patch:

1. Fork it (https://github.com/wbjrpub/folderbrowser/fork).

2. Create your feature branch (git checkout -b my-new-feature).

3. Make changes.

4. Commit your changes (git commit -am ‘Add some feature’).

5. Push to the branch (git push origin my-new-feature).

6. Create a new Pull Request.

License

This Python package is licensed under the MIT license.

Warranty

This software is provided by the copyright holders and contributors “as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.