mirror of
https://github.com/emendir/EndraApp.git
synced 2025-12-23 22:18:10 -05:00
ReadMe & devops improvements
This commit is contained in:
121
LICENCE
Normal file
121
LICENCE
Normal file
@@ -0,0 +1,121 @@
|
||||
Creative Commons Legal Code
|
||||
|
||||
CC0 1.0 Universal
|
||||
|
||||
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
|
||||
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
|
||||
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
|
||||
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
|
||||
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
|
||||
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
|
||||
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
|
||||
HEREUNDER.
|
||||
|
||||
Statement of Purpose
|
||||
|
||||
The laws of most jurisdictions throughout the world automatically confer
|
||||
exclusive Copyright and Related Rights (defined below) upon the creator
|
||||
and subsequent owner(s) (each and all, an "owner") of an original work of
|
||||
authorship and/or a database (each, a "Work").
|
||||
|
||||
Certain owners wish to permanently relinquish those rights to a Work for
|
||||
the purpose of contributing to a commons of creative, cultural and
|
||||
scientific works ("Commons") that the public can reliably and without fear
|
||||
of later claims of infringement build upon, modify, incorporate in other
|
||||
works, reuse and redistribute as freely as possible in any form whatsoever
|
||||
and for any purposes, including without limitation commercial purposes.
|
||||
These owners may contribute to the Commons to promote the ideal of a free
|
||||
culture and the further production of creative, cultural and scientific
|
||||
works, or to gain reputation or greater distribution for their Work in
|
||||
part through the use and efforts of others.
|
||||
|
||||
For these and/or other purposes and motivations, and without any
|
||||
expectation of additional consideration or compensation, the person
|
||||
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
|
||||
is an owner of Copyright and Related Rights in the Work, voluntarily
|
||||
elects to apply CC0 to the Work and publicly distribute the Work under its
|
||||
terms, with knowledge of his or her Copyright and Related Rights in the
|
||||
Work and the meaning and intended legal effect of CC0 on those rights.
|
||||
|
||||
1. Copyright and Related Rights. A Work made available under CC0 may be
|
||||
protected by copyright and related or neighboring rights ("Copyright and
|
||||
Related Rights"). Copyright and Related Rights include, but are not
|
||||
limited to, the following:
|
||||
|
||||
i. the right to reproduce, adapt, distribute, perform, display,
|
||||
communicate, and translate a Work;
|
||||
ii. moral rights retained by the original author(s) and/or performer(s);
|
||||
iii. publicity and privacy rights pertaining to a person's image or
|
||||
likeness depicted in a Work;
|
||||
iv. rights protecting against unfair competition in regards to a Work,
|
||||
subject to the limitations in paragraph 4(a), below;
|
||||
v. rights protecting the extraction, dissemination, use and reuse of data
|
||||
in a Work;
|
||||
vi. database rights (such as those arising under Directive 96/9/EC of the
|
||||
European Parliament and of the Council of 11 March 1996 on the legal
|
||||
protection of databases, and under any national implementation
|
||||
thereof, including any amended or successor version of such
|
||||
directive); and
|
||||
vii. other similar, equivalent or corresponding rights throughout the
|
||||
world based on applicable law or treaty, and any national
|
||||
implementations thereof.
|
||||
|
||||
2. Waiver. To the greatest extent permitted by, but not in contravention
|
||||
of, applicable law, Affirmer hereby overtly, fully, permanently,
|
||||
irrevocably and unconditionally waives, abandons, and surrenders all of
|
||||
Affirmer's Copyright and Related Rights and associated claims and causes
|
||||
of action, whether now known or unknown (including existing as well as
|
||||
future claims and causes of action), in the Work (i) in all territories
|
||||
worldwide, (ii) for the maximum duration provided by applicable law or
|
||||
treaty (including future time extensions), (iii) in any current or future
|
||||
medium and for any number of copies, and (iv) for any purpose whatsoever,
|
||||
including without limitation commercial, advertising or promotional
|
||||
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
|
||||
member of the public at large and to the detriment of Affirmer's heirs and
|
||||
successors, fully intending that such Waiver shall not be subject to
|
||||
revocation, rescission, cancellation, termination, or any other legal or
|
||||
equitable action to disrupt the quiet enjoyment of the Work by the public
|
||||
as contemplated by Affirmer's express Statement of Purpose.
|
||||
|
||||
3. Public License Fallback. Should any part of the Waiver for any reason
|
||||
be judged legally invalid or ineffective under applicable law, then the
|
||||
Waiver shall be preserved to the maximum extent permitted taking into
|
||||
account Affirmer's express Statement of Purpose. In addition, to the
|
||||
extent the Waiver is so judged Affirmer hereby grants to each affected
|
||||
person a royalty-free, non transferable, non sublicensable, non exclusive,
|
||||
irrevocable and unconditional license to exercise Affirmer's Copyright and
|
||||
Related Rights in the Work (i) in all territories worldwide, (ii) for the
|
||||
maximum duration provided by applicable law or treaty (including future
|
||||
time extensions), (iii) in any current or future medium and for any number
|
||||
of copies, and (iv) for any purpose whatsoever, including without
|
||||
limitation commercial, advertising or promotional purposes (the
|
||||
"License"). The License shall be deemed effective as of the date CC0 was
|
||||
applied by Affirmer to the Work. Should any part of the License for any
|
||||
reason be judged legally invalid or ineffective under applicable law, such
|
||||
partial invalidity or ineffectiveness shall not invalidate the remainder
|
||||
of the License, and in such case Affirmer hereby affirms that he or she
|
||||
will not (i) exercise any of his or her remaining Copyright and Related
|
||||
Rights in the Work or (ii) assert any associated claims and causes of
|
||||
action with respect to the Work, in either case contrary to Affirmer's
|
||||
express Statement of Purpose.
|
||||
|
||||
4. Limitations and Disclaimers.
|
||||
|
||||
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
||||
surrendered, licensed or otherwise affected by this document.
|
||||
b. Affirmer offers the Work as-is and makes no representations or
|
||||
warranties of any kind concerning the Work, express, implied,
|
||||
statutory or otherwise, including without limitation warranties of
|
||||
title, merchantability, fitness for a particular purpose, non
|
||||
infringement, or the absence of latent or other defects, accuracy, or
|
||||
the present or absence of errors, whether or not discoverable, all to
|
||||
the greatest extent permissible under applicable law.
|
||||
c. Affirmer disclaims responsibility for clearing rights of other persons
|
||||
that may apply to the Work or any use thereof, including without
|
||||
limitation any person's Copyright and Related Rights in the Work.
|
||||
Further, Affirmer disclaims responsibility for obtaining any necessary
|
||||
consents, permissions or other rights required for any use of the
|
||||
Work.
|
||||
d. Affirmer understands and acknowledges that Creative Commons is not a
|
||||
party to this document and has no duty or obligation with respect to
|
||||
this CC0 or use of the Work.
|
||||
38
README.md
38
README.md
@@ -1,8 +1,26 @@
|
||||
## Endra App
|
||||
|
||||
_P2P Messenger_
|
||||
A P2P encrypted messenger supporting multiple devices per user.
|
||||
|
||||
Based on IPFS, the Walytis database blockchain, and Walytis-Identities DID management technologies, this peer to peer messenger support multiple devices per user, and group chats.
|
||||
Endra combines Walytis' peer-to-peer distributed database, WalytisIdentities' identity & cryptography management, and WalytisOffchain's secure data storage & transmission, and WalytisMutability's database editing abstraction to form a fully featured messaging protocol.
|
||||
|
||||
It can be used for more than just instant messaging - shared calendars, project management tools and an endless amount of distributed communications systems can be built using it.
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
- fully peer to peer, no servers of any kind
|
||||
- can function independently of internet connectivity
|
||||
- full end-to-end encryption ephemeral keys, algorithm-agnostic & future-proof
|
||||
- multiple devices per profile (user account)
|
||||
- multiple profiles per device
|
||||
- can be used as a library for embedding into other applications
|
||||
- will become part of an expandable ecosystem incl. calendar and file-sharing
|
||||
- [app for desktop and mobile](https://github.com/emendir/EndraApp) (tested on Linux (Ubuntu x86-64) and Android (arm-64))
|
||||
|
||||
### Disadvantages
|
||||
|
||||
- higher resource usage on user devices compared to conventional messengers
|
||||
|
||||
## Run From Source
|
||||
|
||||
@@ -22,7 +40,7 @@ USE_PANGO=0 python .
|
||||
|
||||
- `USE_PANGO` (defaults to true on Linux): Use the Pango text provider to enable broader character & emoji text rendering support
|
||||
- `USE_BRENTHY` (defaults to false): Instead of running an embedded IPFS and Walytis node, use the separately running system services for IPFS and Walytis. This enables faster loading times. To set up IPFS & Walytis in this way, [install Brenthy](https://github.com/emendir/BrenthyAndWalytis)
|
||||
|
||||
- `KIVY_NO_CONSOLELOG` (defaults to false): stop kivy logging to console
|
||||
## DevOps
|
||||
|
||||
For speedy starting and termination of the app, on Linux, [install Brenthy](https://github.com/emendir/BrenthyAndWalytis) to run Walytis & IPFS as a systemd service.
|
||||
@@ -49,3 +67,17 @@ To reset the appdata, run:
|
||||
```sh
|
||||
rm -rf tests/appdata
|
||||
```
|
||||
|
||||
## Related Projects
|
||||
### The Endra Tech Stack
|
||||
|
||||
- [IPFS](https://ipfs.tech): A p2p communication and content addressing protocol developed by ProtocolLabs.
|
||||
- [Walytis](https://github.com/emendir/Walytis_Beta): A flexible, lightweight, nonlinear database-blockchain, built on IPFS.
|
||||
- [WalytisIdentities](https://github.com/emendir/WalytisIdentities): P2P multi-controller cryptographic identity management, built on Walytis.
|
||||
- [WalytisOffchain](https://github.com/emendir/WalytisOffchain): Secure access-controlled database-blockchain, built on WalytisIdentities.
|
||||
- [WalytisMutability](https://github.com/emendir/WalytisMutability): A Walytis blockchain overlay featuring block mutability.
|
||||
- [Endra](https://github.com/emendir/Endra): A p2p encrypted messaging protocol with multiple devices per user, built on Walytis.
|
||||
- [EndraApp](https://github.com/emendir/EndraApp): A p2p encrypted messenger supporting multiple devices per user, built on Walytis.
|
||||
|
||||
### Alternative Technologies
|
||||
- Berty: a p2p messenger for mobile phones built on IPFS & OrbitDB
|
||||
@@ -8,7 +8,7 @@ MAGENTA='\033[0;35m'
|
||||
CYAN='\033[0;36m'
|
||||
WHITE='\033[0;37m'
|
||||
NC='\033[0m' # no colour
|
||||
|
||||
set -e
|
||||
echo -e "$YELLOW
|
||||
REMEMBER: If you've updated dependecies, run:"
|
||||
echo -e "$MAGENTA
|
||||
@@ -37,14 +37,14 @@ if ! [ -e ~/.buildozer ];then
|
||||
fi
|
||||
|
||||
|
||||
# docker run \
|
||||
# -v $HOME/.buildozer:/home/user/.buildozer \
|
||||
# -v $WORK_DIR/buildozer.spec:/home/user/hostcwd/buildozer.spec \
|
||||
# -v $WORK_DIR/.buildozer:/home/user/hostcwd/.buildozer \
|
||||
# -v $WORK_DIR/bin:/home/user/hostcwd/bin \
|
||||
# -v $PROJ_DIR/src:/home/user/hostcwd/src \
|
||||
# $DOCKER_IMAGE android debug
|
||||
#
|
||||
docker run \
|
||||
-v $HOME/.buildozer:/home/user/.buildozer \
|
||||
-v $WORK_DIR/buildozer.spec:/home/user/hostcwd/buildozer.spec \
|
||||
-v $WORK_DIR/.buildozer:/home/user/hostcwd/.buildozer \
|
||||
-v $WORK_DIR/bin:/home/user/hostcwd/bin \
|
||||
-v $PROJ_DIR/src:/home/user/hostcwd/src \
|
||||
$DOCKER_IMAGE android debug
|
||||
|
||||
|
||||
|
||||
# SSH_ADDR=phablet@10.42.0.200
|
||||
|
||||
@@ -38,7 +38,8 @@ python_packages=$(while IFS= read -r line; do
|
||||
[[ $line == PyQt* ]] && continue # skip PyQt cause we're using a PyQt base
|
||||
printf '%s ' "$line"
|
||||
done < $PROJECT_DIR/requirements.txt)
|
||||
# flatpak_pip_generator $python_packages
|
||||
flatpak_pip_generator $python_packages
|
||||
|
||||
cd $PROJECT_DIR
|
||||
# validate Flatpak Manifest
|
||||
flatpak run --command=flatpak-builder-lint org.flatpak.Builder manifest "${SCRIPT_DIR}/${APP_ID}.yml"
|
||||
|
||||
@@ -17,6 +17,6 @@
|
||||
<content_attribute id="language-profanity">none</content_attribute>
|
||||
</content_rating>
|
||||
<releases>
|
||||
<release version="0.1.3" date="2025-06-12" />
|
||||
<release version="0.1.3" date="2025-07-17" />
|
||||
</releases>
|
||||
</component>
|
||||
2
run_app.sh
Normal file
2
run_app.sh
Normal file
@@ -0,0 +1,2 @@
|
||||
#!/bin/bash
|
||||
USE_PANGO=0 WALYTIS_BETA_API_TYPE=WALYTIS_BETA_DIRECT_API IPFS_TK_MODE=EMBEDDED python tests/test_app.py
|
||||
@@ -1,7 +1,7 @@
|
||||
# side_bar.py
|
||||
from kivy.clock import Clock
|
||||
import json
|
||||
from loguru import logger
|
||||
from .log import logger
|
||||
from kivy.uix.boxlayout import BoxLayout
|
||||
from kivy.lang import Builder
|
||||
from endra import Message, Correspondence, MessageContent
|
||||
|
||||
@@ -19,8 +19,6 @@ elif platform in ('linux', 'win', 'macosx'):
|
||||
APPDATA_DIR = os.path.join(user_data_dir(), "Endra")
|
||||
else:
|
||||
raise NotImplementedError(f"Unsupported platform: {platform}")
|
||||
import loguru
|
||||
loguru.logger.add(os.path.join(APPDATA_DIR, "Endra.log"), rotation="1 week")
|
||||
|
||||
# APPDATA_DIR = os.path.join(user_data_dir(), "Endra")
|
||||
# APPDATA_DIR = os.path.join(".", "EndraAppdata")
|
||||
|
||||
@@ -1,19 +1,25 @@
|
||||
from loguru import logger
|
||||
import logging
|
||||
from .log import logger
|
||||
from walytis_beta_embedded import ipfs
|
||||
from kivy import platform
|
||||
import os
|
||||
|
||||
IPFS_LOG_TOPIC = f"endra_logs_{platform}"
|
||||
IPFS_LOG_PEERS = [
|
||||
|
||||
"/ip4/192.168.189.106/tcp/4001/p2p/12D3KooWCq7RiBeLTZFeBRX4zmfYDunHPmgT3zZSdQKcx7Es34py",
|
||||
]
|
||||
|
||||
|
||||
def log_to_ipfs(log_message):
|
||||
ipfs.pubsub.publish(IPFS_LOG_TOPIC, log_message)
|
||||
class IPFSHandler(logging.Handler):
|
||||
def emit(self, record):
|
||||
log_entry = self.format(record)
|
||||
ipfs.pubsub.publish(IPFS_LOG_TOPIC, f"{log_entry}\n")
|
||||
|
||||
|
||||
logger.add(log_to_ipfs)
|
||||
ipfs_handler = IPFSHandler()
|
||||
ipfs_handler.setFormatter(logging.Formatter('%(asctime)s - %(levelname)s - %(message)s'))
|
||||
|
||||
logger.addHandler(ipfs_handler)
|
||||
|
||||
import os
|
||||
PEERS_FILEPATH=os.path.join(os.path.dirname(__file__), "ipfs_bootstrap_peers.txt")
|
||||
for peer in IPFS_LOG_PEERS:
|
||||
peer_id = [part for part in peer.split("/") if part][-1]
|
||||
@@ -21,5 +27,4 @@ for peer in IPFS_LOG_PEERS:
|
||||
continue
|
||||
logger.info(f"endra_app.endra_logging: connecting to peer {peer}")
|
||||
ipfs.peers.connect(peer)
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
import portalocker
|
||||
from loguru import logger
|
||||
import os
|
||||
|
||||
|
||||
def run():
|
||||
# # IMPORT ORDER IS IMPORTANT
|
||||
from .log import logger
|
||||
from . import _load_kivy
|
||||
from kivy import platform
|
||||
# if platform == "android":
|
||||
|
||||
30
src/endra_app/log.py
Normal file
30
src/endra_app/log.py
Normal file
@@ -0,0 +1,30 @@
|
||||
import logging
|
||||
from logging.handlers import RotatingFileHandler
|
||||
# Formatter
|
||||
formatter = logging.Formatter(
|
||||
'%(asctime)s [%(levelname)s] %(name)s: %(message)s'
|
||||
)
|
||||
|
||||
# Console handler (INFO+)
|
||||
console_handler = logging.StreamHandler()
|
||||
console_handler.setLevel(logging.INFO)
|
||||
console_handler.setFormatter(formatter)
|
||||
|
||||
# File handler (DEBUG+ with rotation)
|
||||
file_handler = RotatingFileHandler(
|
||||
'app.log', maxBytes=5*1024*1024, backupCount=5
|
||||
)
|
||||
file_handler.setLevel(logging.DEBUG)
|
||||
file_handler.setFormatter(formatter)
|
||||
|
||||
# Root logger
|
||||
# root_logger = logging.getLogger()
|
||||
# root_logger.setLevel(logging.DEBUG) # Global default
|
||||
# root_logger.addHandler(console_handler)
|
||||
# root_logger.addHandler(file_handler)
|
||||
|
||||
|
||||
|
||||
logger = logging.getLogger("Endra")
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
from .config import APPDATA_DIR
|
||||
from . import config
|
||||
import walytis_beta_embedded
|
||||
from loguru import logger
|
||||
from .log import logger
|
||||
import tempfile
|
||||
from datetime import datetime
|
||||
from walytis_identities.did_objects import Key
|
||||
@@ -17,7 +17,6 @@ import os
|
||||
print("mainwindow.py")
|
||||
|
||||
print("Imported components.")
|
||||
|
||||
CRYPTO_FAMILY = "EC-secp256k1"
|
||||
TEMP_HARDCODED_KEY = Key(
|
||||
family=CRYPTO_FAMILY,
|
||||
@@ -149,7 +148,7 @@ class MainApp(App):
|
||||
profile.terminate()
|
||||
|
||||
if not config.USE_BRENTHY:
|
||||
logger.debug("Mainwindow: Terminating Wwalytis_beta_embedded!")
|
||||
logger.debug("Mainwindow: Terminating Walytis_beta_embedded!")
|
||||
walytis_beta_embedded.terminate()
|
||||
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ from kivy.uix.popup import Popup
|
||||
from endra import Profile
|
||||
from .utils import InvitationPopupView
|
||||
import json
|
||||
from loguru import logger
|
||||
from .log import logger
|
||||
from kivy.uix.boxlayout import BoxLayout
|
||||
from kivy.lang import Builder
|
||||
import os
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
from endra import Device
|
||||
from .utils import InvitationPopupView
|
||||
import json
|
||||
from loguru import logger
|
||||
from .log import logger
|
||||
from kivy.uix.boxlayout import BoxLayout
|
||||
from kivy.lang import Builder
|
||||
from endra import Profile
|
||||
|
||||
@@ -6,7 +6,7 @@ from .profiles import Profiles
|
||||
from .settings import ProfileSettingsPopup
|
||||
from walytis_beta_tools.exceptions import JoinFailureError
|
||||
import json
|
||||
from loguru import logger
|
||||
from .log import logger
|
||||
from kivy.uix.boxlayout import BoxLayout
|
||||
from kivy.lang import Builder
|
||||
from endra import Profile, Correspondence
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
|
||||
from loguru import logger
|
||||
from endra_app.log import logger
|
||||
import traceback
|
||||
|
||||
|
||||
|
||||
@@ -8,7 +8,6 @@ from endra_app.config import APPDATA_DIR
|
||||
import os
|
||||
import endra_app
|
||||
from endra_app import run
|
||||
walytis_api.log.PRINT_DEBUG = False
|
||||
|
||||
|
||||
_testing_utils.assert_is_loaded_from_source(
|
||||
|
||||
Reference in New Issue
Block a user