Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update READMEs for archiving Python daemon #1746

Merged
merged 1 commit into from
Feb 14, 2025
Merged

docs: Update READMEs for archiving Python daemon #1746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 1 addition & 27 deletions packages/c/sshnpd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,7 @@

## Status

The C version of sshnpd is currently in alpha, we are working hard to deliver a
lighter weight and more widely available version of sshnpd (NoPorts device
daemon).

## Caveats

Because this is still in alpha, and it is dependent on the alpha
[C atSDK](https://github.com/atsign-foundation/at_c), this version of sshnpd is
expected to have both known and unknown bugs as it undergoes extensive testing
and analysis.

### Known bugs

There are some known memory leaks in the current alpha (0.1.0) release. We are
actively addressing the most critical ones first, and will provide valgrind
suppression files for non-critical ones.

In this case, "non-critical memory leaks" includes finite memory leaks which
will not grow with continued use of the software. This can include:

- Memory leaks which are cleaned upon closure of a forked child process
- Memory which should be allocated for the entire life of the main process

### Likely bugs

Stability around system calls is not well tested, and may not work in all
environments. We have done our best to use portable solutions where possible.
The C version of sshnpd is production ready.

## How to build

Expand Down
13 changes: 12 additions & 1 deletion packages/python/sshnpd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,18 @@
[![PyPI version](https://badge.fury.io/py/sshnpd.svg)](https://badge.fury.io/py/sshnpd)
[![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)

# SSHNPD Python (beta)
# ARCHIVED - SSHNPD Python (beta)

0.4.16 will be the final release of this package, which is being archived.

Pyhton was chosen to implement a NoPorts daemon that was more portable than
the Dart version, but unfortunately the installation footprint was too large
for many of the intended devices.

With the production release of the
[C NoPorts daemon](https://github.com/atsign-foundation/noports/tree/trunk/packages/c/sshnpd)
we now recommend that be used for any devices where a small portable
implementation is required.

SSH No Ports provides a way to ssh to a remote linux host/device without that
device or the client having any open ports (not even 22) on external
Expand Down
4 changes: 2 additions & 2 deletions packages/python/sshnpd/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "sshnpd"
version = "0.4.15"
version = "0.4.16"
description = "Python implementation of SSH No Ports daemon"
authors = ["Xavier Lin <[email protected] >"]
maintainers = ["Chris Swan <[email protected]>"]
Expand All @@ -12,7 +12,7 @@ sshnpd = 'sshnpd:main'

[tool.poetry.dependencies]
python = "^3.10"
atsdk = "0.2.30"
atsdk = "0.2.33"

[build-system]
requires = ["poetry-core"]
Expand Down