Merge pull request #50 from Morpheus636/main

Release v1.2.0

.github/workflows/build_binaries.yml

@@ -16,11 +16,12 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2
+      - run: git fetch --prune --tags --unshallow
 
       - name: Setup Python
         uses: actions/setup-python@v1
         with:
-          python-version: 3.9
+          python-version: "3.10"
 
       - name: Setup Poetry
         uses: Gr1N/setup-poetry@v7
@@ -29,7 +30,7 @@ jobs:
         run: poetry install
 
       - name: Build Pyinstaller
-        run: poetry run pyinstaller --onefile ./src/zeal_cli.py --name zeal-cli
+        run: make build
 
       - name: Upload Executables
         uses: softprops/[email protected]

.github/workflows/code_analysis_pull.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v1
         with:
-          python-version: 3.9
+          python-version: "3.10"
 
       - name: Setup Poetry
         uses: Gr1N/setup-poetry@v7
@@ -32,7 +32,7 @@ jobs:
         run: poetry run isort
 
       - name: Black (Code Formatter)
-        run: poetry run black
+        run: find . -type f -name "*.py" | xargs poetry run black
 
       - name: Check for changes
         id: changes

.github/workflows/tests.yml

@@ -17,17 +17,21 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2
+      - run: git fetch --prune --tags --unshallow
 
       - name: Setup Python
         uses: actions/setup-python@v1
         with:
-          python-version: 3.9
+          python-version: "3.10"
 
       - name: Setup Poetry
         uses: Gr1N/setup-poetry@v7
 
       - name: Install Packages
         run: poetry install
 
-      - name: Test
+      - name: Run PyTest
         run: poetry run pytest
+
+      - name: Build Test
+        run: make build

Makefile

@@ -0,0 +1,18 @@
+build:
+	poetry run python ./build_system/update_version.py
+	poetry run pyinstaller --onefile ./src/zeal_cli.py --name zeal-cli
+
+.PHONY: clean
+clean:
+	git checkout HEAD ./src/zeal/version.py
+	rm -rf ./dist
+	rm -rf ./zeal-cli.spec
+	rm -rf ./build
+
+.PHONY: linux-install
+linux-install:
+	poetry install
+	rm ~/.local/bin/zeal-cli
+	make build
+	chmod +x ./dist/zeal-cli
+	cp ./dist/zeal-cli ~/.local/bin/zeal-cli

build_system/update_version.py

@@ -0,0 +1,10 @@
+import os
+
+import git
+
+
+repo = git.Repo(search_parent_directories=True)
+version = repo.git.describe("--tags")
+
+with open(os.path.join(os.getcwd(), "src", "zeal", "version.py"), "w") as file:
+    file.write(f'build_version = "{version}"\n')

docs/README.md

@@ -1,11 +1,43 @@
 # Zeal CLI
 Zeal CLI is a command-line-interface for managing [Zeal](https://zealdocs.org/) docsets on Linux. It's syntax is roughly based on the basic syntax of the `apt` package manager, because Zeal CLI is basically a package manager for docsets.
 
-Just like Zeal, Zeal_CLI sources docsets from [Dash](https://kapeli.com/dash). Special thanks to Dash's developer, [Kapeli](https://github.com/Kapeli) for granting me permission to use their docsets.
+## Features
+- Simple, familiar command-line interface
+- Gets docsets from the same source as Zeal
+- Easy to install and use - no additional dependencies required.
+- Docsets can still be managed within the Zeal GUI
+- Free and Open-Source
 
-## Usage for Non-Contributors
+## Technologies
+- Python 3
+- PyInstaller
+
+## Usage
 View the [usage documentation](usage.md) for using instructions.
 
-## Documentation
-To view all the available documentation for this project, please see the [Documents Index](INDEX.md)
-This includes information on getting started, the development environment, and more.
+## Contact
+To submit a Bug Report or Feature Request, please open a [GitHub Issue](https://github.com/Morpheus636/zeal-cli/issues/new).
+
+To ask a question or get support, you can join my [Discord Server](https://discord.morpheus636.com) or create a Discussions thread within this repository.
+
+## Contributing
+This project is maintained my Morpheus636. Contribution guidelines for all of my projects can be found at https://docs.morpheus636.com/contributing
+
+## Credits
+- Zeal_CLI sources docsets from [Dash](https://kapeli.com/dash), just like Zeal. Special thanks to Dash's developer, [Kapeli](https://github.com/Kapeli) for granting me permission to use their docsets.
+
+# Copyright Notice
+© Copyright 2021-2022 Josh Levin ([Morpheus636](https://github.com/morpheus636))
+
+This repository (and everything in it) 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 repository 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 repository.  If not, see <https://www.gnu.org/licenses/>.

docs/usage.md

@@ -3,13 +3,17 @@ Right now, Zeal_CLI only supports Linux.
 
 # Installation
 
-## Linux - Executable
+## Linux - Pre Built
 1. Download the linux build from the most recent [release](https://github.com/Morpheus636/zeal_cli/releases)
-2. Create a directory `~/zeal-cli/`
-3. Copy the linux build to that directory.
-4. Give the file executable permissions (`chmod +x ~/zeal-cli/zeal-cli`)
-5. Symlink it to a location on PATH (I personally use `~/.local/bin/`)
+3. Copy the linux build to `~/.local/bin` (or another location on PATH)
+4. Give the file executable permissions (`chmod +x ~/.local/bin/zeal-cli`)
 6. Run it with `zeal-cli`
 
+## Linux - From Source
+1. Clone this repo using Git - `git clone https://github.com/Morpheus636/zeal-cli.git`
+2. Checkout the repo at the most recent version tag (or branch) - `git checkout tags/<tag_name>` or `git checkout origin/<branch_name>`
+3. Run `make clean` (May not be nessesary if its your first time building zeal-cli, but won't hurt)
+4. Run `make linux-install`
+
 ## Usage
 Usage information can be found by running `zeal-cli --help`