mirror/EndraApp
1
0
Fork 0
mirror of https://github.com/emendir/EndraApp.git synced 2025-12-23 22:18:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

README update, added licences

Browse Source
This commit is contained in:
Emendir
2025-09-14 11:47:56 +02:00
parent 20796cffae
commit c01a4f2b80
6 changed files with 246 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
ComparisonToBerty.md
View File

@@ -2,9 +2,9 @@
- built upon IPFS-based distributed databases
## Endra
- built on the highly modular Walytis ecosystem
- built on the highly modular [Walytis Technologies ecosystem](https://github.com/emendir/WalytisTechnologies/blob/master/Endra/2-EndraStack.md)
## Berty
- built mostly on the Wesh protocol
- built on the [Wesh protocol](https://berty.tech/docs/protocol/) (as of 2025-09 not fully implemented)

18
LICENSE Normal file
View File

@@ -0,0 +1,18 @@
MIT No Attribution
Copyright [year] [fullname]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

121
LICENSE-CC0 Normal file
View 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 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.

103
README.md
View File

@@ -18,22 +18,21 @@ It can be used for more than just instant messaging - shared calendars, project
- 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))
#### Features Coming Soon
So far the main focus of Endra has been its foundational architecture, so until now little work has been invested in essential higher-level messaging features.
However, now is the time where some of these will start being developed and tested:
- rich text formatting (markdown as default, perhaps others too)
- inline multimedia
- file attachments with progress tracking for transmission
- take photos with camera
- scan QR-codes
- record audio with microphone
- zip-file backups
### Disadvantages
- higher resource usage on user devices compared to conventional messengers
## Project Status **EXPERIMENTAL**
This library is very early in its development.
The API of this library IS LIKELY TO CHANGE in the near future!
## Documentation
To learn how Endra works, visit the documentation in its dedicated repo at:
https://github.com/emendir/WalytisTechnologies/blob/master/EndraApp/1-IntroToEndraApp.md
## Run From Source
Install Prerequisites:
@@ -80,16 +79,84 @@ To reset the appdata, run:
rm -rf tests/appdata
```
## Related Projects
### The Endra Tech Stack
## Documentation
The thorough documentation for this project and the technologies it's based on live in a dedicated repository:
- [EndraApp](https://github.com/emendir/WalytisTechnologies/blob/master/EndraApp/1-IntroToEndraApp.md): learn how EndraApp works
- [Walytis Technologies](https://github.com/emendir/WalytisTechnologies): learn about the suite of tools which EndraApp is part of, built to enable developers to easily develop peer-to-peer distributed applications.
## Project Status **EXPERIMENTAL**
This library is very early in its development.
The API of this library IS LIKELY TO CHANGE in the near future!
## [RoadMap](https://github.com/emendir/WalytisTechnologies/blob/master/RoadMap.md)
See the [Walytis Technologies RoadMap](https://github.com/emendir/WalytisTechnologies/blob/master/RoadMap.md) for the current plans for EndraApp in the context of the larger [Walytis Technologies Project](https://github.com/emendir/WalytisTechnologies).
## Contributing
### Get Involved
- GitHub Discussions: if you want to share ideas
- GitHub Issues: if you find bugs, other issues, or would like to submit feature requests
- GitHub Merge Requests: if you think you know what you're doing, you're very welcome!
### Financial Support
To support me in my work on this and other projects, you can make donations with the following currencies:
- **Bitcoin:** `BC1Q45QEE6YTNGRC5TSZ42ZL3MWV8798ZEF70H2DG0`
- **Ethereum:** `0xA32C3bBC2106C986317f202B3aa8eBc3063323D4`
- [**Fiat** (via Credit or Debit Card, Apple Pay, Google Pay, Revolut Pay)](https://checkout.revolut.com/pay/4e4d24de-26cf-4e7d-9e84-ede89ec67f32)
Donations help me:
- dedicate more time to developing and maintaining open-source projects
- cover costs for IT infrastructure
- finance projects requiring additional hardware & compute
## About the Developer
This project is developed by a human one-man team, publishing under the name _Emendir_.
I build open technologies trying to improve our world;
learning, working and sharing under the principle:
> _Freely I have received, freely I give._
Feel welcome to join in with code contributions, discussions, ideas and more!
## Open-Source in the Public Domain
I dedicate this project to the public domain.
It is open source and free to use, share, modify, and build upon without restrictions or conditions.
I make no patent or trademark claims over this project.
Formally, you may use this project under either the:
- [MIT No Attribution (MIT-0)](https://choosealicense.com/licenses/mit-0/) or
- [Creative Commons Zero (CC0)](https://choosealicense.com/licenses/cc0-1.0/)
licence at your choice.
## Related Projects
### [Walytis Technologies](https://github.com/emendir/WalytisTechnologies)
An overarching project comprising the development of Walytis and a collection of tools based on it for real-world peer-to-peer communications.
- [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.
- [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.
### [IPFS](https://ipfs.tech)
A P2P communication and content addressing protocol developed by Protocol Labs.
This is the networking foundation which Walytis builds upon.
### Alternative Technologies
- Berty: a p2p messenger for mobile phones built on IPFS & OrbitDB
- [Berty](https://berty.tech/messenger): a P2P messenger for mobile phones built on [IPFS](https://ipfs.tech) & [OrbitDB](https://orbitdb.org/)

22
ToDo.md
View File

@@ -2,11 +2,13 @@
## DevOps
- [ ] Pakaging for:
- [x] Android
- [x] Linux
- [ ] Windows
- [ ] MacOS
- [ ] Pakaging: ⏫
- [x] Android
- [x] Linux x86-64
- [x] Linux arm-64
- [ ] Windows
- [ ] MacOS-x86-64
- [ ] MacOS-arm-64
## UI
@@ -16,11 +18,15 @@
## Messenger Features
- [ ] file messages
- [ ] rich text formatting
- [ ] multimedia support
- [ ] file transmission (large files)
- [ ] audio calls
- [ ] file transmission (with transmission progress tracking for large files)
- [ ] audio calls ⏫
- [ ] video calls
- [ ] camera photos
- [ ] audio recordings
- [ ] QR-code scanning
- [ ] zip-file backups
## Settings

12
src/endra_app/endra_logging.py
View File

@@ -5,9 +5,8 @@ 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",
]
IPFS_LOG_PEERS = []
class IPFSHandler(logging.Handler):
def emit(self, record):
@@ -16,15 +15,16 @@ class IPFSHandler(logging.Handler):
ipfs_handler = IPFSHandler()
ipfs_handler.setFormatter(logging.Formatter('%(asctime)s - %(levelname)s - %(message)s'))
ipfs_handler.setFormatter(
logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
)
logger.addHandler(ipfs_handler)
PEERS_FILEPATH=os.path.join(os.path.dirname(__file__), "ipfs_bootstrap_peers.txt")
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]
if peer_id == ipfs.peer_id:
continue
logger.info(f"endra_app.endra_logging: connecting to peer {peer}")
ipfs.peers.connect(peer)