Skip to content

Commit

Permalink
Merge pull request #1 from mind-network/dev
Browse files Browse the repository at this point in the history
v1.0.0 release
  • Loading branch information
dennis-mind authored Jul 15, 2023
2 parents 46654f9 + e33ec99 commit 8216a75
Show file tree
Hide file tree
Showing 10 changed files with 1,335 additions and 0 deletions.
171 changes: 171 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
tests/env.py
tests_internal/env.py
tests_publish/env.py
/env.py
wallet.json
arweave_wallet.json

dist/*
.DS_Store

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
examples/env.py
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Mind DataPack Python SDK

An Python implementation for Mind DataPack

## Description

Mind Network is a permissionless and scalable zero-trust data lake. Its core feature is to compute over encrypted data and allow that data to be stored in various Web3 storage protocols.

DataPack, contributed by the Mind Network Team, is to enable data transformation and transportation between Mind Network and storage protocols, like Arweave. It is an adapter that facilitates the smooth conversion of data between plaintext and ciphertext to be stored in Mind Network or Arweave. This module empowers users to retrieve their infrequently processed data, known as "cold data," from Mind Network and store it in local or decentralized storage. When the need arises to perform computing on the encrypted data again, users can effortlessly load it back into Mind Network for processing.


## Getting Started

### Dependencies

* Python > 3.8
* pip
* mindlakesdk
* arseeding

### Installing

* pip install minddatapack

### Import
```
from minddatapack import DataPack
...
```

### More examples
* [use case of arweave in jupyter](/examples/use_case_arweave.ipynb)

## code
```
mind-datapack-python
|-- minddatapack # source code
| |-- __init__.py
| |-- arweaveconnector.py
| |-- localfileconnector.py
| |-- mindlakeconnector.py
| └-- utils.py
|-- examples # use case examples
|-- README.md
└--- LICENSE
```

## Help

Full doc: [https://mind-network.gitbook.io/mind-lake-sdk](https://mind-network.gitbook.io/mind-lake-sdk)

## Authors

* Dennis [@NuIlPtr](https://twitter.com/nuilptr)
* George [@georgemindnet](https://twitter.com/georgemindnet)

## Version History

* v1.0
* Initial Release

## License

This project is licensed under the [MIT] License - see the LICENSE.md file for details
7 changes: 7 additions & 0 deletions examples/env_template.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# template to configure for mindlakesdk

walletPrivateKey = '??????????'

mindLakeAppKey = '??????????'

MINDLAKE_GATEWAY = 'https://sdk.mindnetwork.xyz/node'
4 changes: 4 additions & 0 deletions examples/example_data.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
uid,wallet_address,register_date
123,0x79Be957bf7e3003aFd0e78f04Bacbc93D3ef2fB7,2023-07-15 02:25:32.392441
124,0x79Be957bf7e3003aFd0e78f04Bacbc93D3ef2fB7,2023-07-15 02:25:32.392441
125,0x79Be957bf7e3003aFd0e78f04Bacbc93D3ef2fB7,2023-07-15 02:25:32.392441
Loading

0 comments on commit 8216a75

Please sign in to comment.