Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Commit

Permalink
Final release (#242)
Browse files Browse the repository at this point in the history
  • Loading branch information
cbrews authored Apr 20, 2024
1 parent 8ed0c27 commit 522db8a
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 44 deletions.
7 changes: 0 additions & 7 deletions .github/dependabot.yml

This file was deleted.

16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,10 @@ In addition, in order to provide stability and simplicity, minimal third-party d

![The status is good to go. This is Gemini Control.](docs/img/transcript-2.png)

Ignition is currently in prerelease. You can use Ignition today at your own risk, please monitor this repository for changes until version 1.0 is released. Please be advised that there may be breaking changes in the API until that time.

You can see ignition in action at [gemini.cbrews.xyz](https://gemini.cbrews.xyz).
Ignition is no longer being updated.

## Installation
⚠ Ignition currently supports Python versions 3.7 - 3.12.
⚠ Ignition supports Python versions 3.7 - 3.12.

Ignition can be installed via [PIP](https://pypi.org/project/ignition-gemini/). You should install it in alignment with your current development process; if you do not have a build process yet, I recommend you install within a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)

Expand Down Expand Up @@ -61,7 +59,7 @@ In **all** cases, Ignition assumes that the specified endpoint and protocol will

![This is Gemini Control. The conversation between pilot and ground so far in this filght has largely been confined to the normal type of test pilot talk that you would expect.](docs/img/transcript-3.png)

✅ Ignition currently supports the following features:
✅ Ignition supports the following features:
* Basic request/response connectivity to a Gemini-enabled server.
* Basic URL parsing mechanics to allow for specifying protocol, host, port, path, and query params, as per [RFC-3986](https://tools.ietf.org/html/rfc3986)
* Optional referer URL handling. Ignition allows the user to pass a path & referer URL and can construct the new path, to simplifying the resolution of links on a Gemini capsule page.
Expand All @@ -79,8 +77,6 @@ In **all** cases, Ignition assumes that the specified endpoint and protocol will
* Command line or GUI interface.
* Advanced session & history management.
* Support for other protocols.

⚠ These features are not currently supported but may be supported in the future:
* Non-verified certificate scheme
* Improved TOFU scenarios

Expand Down Expand Up @@ -157,14 +153,12 @@ Full API documentation for Ignition is available [here](./docs/api.md).

![There are a few reports from the pilots. They are simply identifying their flight plan very carefully. Four minutes into the flight, Gordon Cooper just told Grissom that he is looking mighty good. Gus gave him a reasuring laugh. A very calm pilot in command of that spacecraft.](docs/img/transcript-4.png)

Want to help contribute to Ignition? See the [developer documentation](./docs/developer.md) for contribution guidelines, build processes, and testing.

The developer documentation is still being completed, if you have specific questions, please open tickets within this project.
Ignition is no longer accepting contributions. Please feel free to fork this repository.

## License
Ignition is licensed under [Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/).

Copyright 2020-2022 by [Chris Brousseau](https://github.com/cbrews).
Copyright 2020-2024 by [Chris Brousseau](https://github.com/cbrews).

## Thank you
* *solderpunk* for leading the design of the [Gemini protocol](https://geminiprotocol.net/docs/specification.html), without which this project would not have been possible.
Expand Down
26 changes: 2 additions & 24 deletions docs/developer.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
# Developing for Ignition

This section is for software developers who are interested in contributing to the `ignition` project.
This section is a legacy document preserved for software developers who are interested in forking this project.

## Contributing

*Bugs*: If you find a problem with the software, you may open a Github issue for the bug. Additionally, if you have found a solution, please go ahead and open a PR with a fix. A Github issue is not required if you are able to just open a PR. Please ensure that:
* The issue is clearly described (what versions of Python are affected, if not all)
* Provide clear steps on how to test, if applicable
* All linting and tests pass
* Documentation is updated as needed

*Features*: Please feel free to pull any issue to for feature development and create a PR. Please note: due to the intentional small scope of this project, we are not currently accepting pull requests for new features without a corresponding issue approved by the core developer.
Ignition is no longer accepting contributions. Please consider forking this library.

## Developing

Expand Down Expand Up @@ -53,19 +47,3 @@ Unit testing is build through `pytest`. Unit test can be run by:
```
$ python -m pytest
```

### Version testing
Version testing is currently handled within Github actions.

## Contributing Guidelines

### Code of Conduct
First and foremost, be a good citizen of the Open Source community and of the Geminisphere. Please be friendly, respectful, professional, and patient with other participants in the community.

Be welcoming to new members; remember that no one has the same background and experience as you. By elevating other perspectives, we can uncover the best solutions and develop the best software.

We will always appreciate good faith conversation and contribution in the community. In addition, we ask you to come with these values: be thoughtful, resourceful, and curious when you engage on this project. Disagreements may occur; but through maintaining these values, any disagreement can become a learning opportunity.

There will always be bugs and issues with code. In the event of proposed change, please keep in mind that the core developer will be able to remediate and/or resolve any issues at their convenience, given that this project is in no means a primary business or primary source of income.

The core developer will make a best effort to maintain backwards compatibility after release 1.0 as possible but in certain circumstances such compatibility may not be possible.
2 changes: 1 addition & 1 deletion ignition/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
from .ssl.cert_store import CertStore
from .util import TimeoutManager

__version__ = "0.2.1"
__version__ = "1.0.0"

__timeout = TimeoutManager(DEFAULT_REQUEST_TIMEOUT)
__cert_store = CertStore(DEFAULT_HOSTS_FILE)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ readme = "README.md"
license = { text = "MPL 2.0" }
requires-python = ">=3.7"
classifiers = [
"Development Status :: 3 - Alpha",
"Development Status :: 7 - Inactive",
"Intended Audience :: Developers",
"Topic :: Software Development :: Libraries",
"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
Expand Down

0 comments on commit 522db8a

Please sign in to comment.