Skip to content

Commit 7e2456a

Browse files
CXINFINITECXINFINITE
committed
Repo structure refined and new components added.
Added Brython SPA (+Django example) - web application. (https://brython.info/) Added U-API (+Django example) - dynamic, Unified/Universal - API System.
1 parent 8b45297 commit 7e2456a

File tree

172 files changed

+40391
-52
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

172 files changed

+40391
-52
lines changed

‎.gitignore

+128-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,130 @@
1-
# Python cache files
2-
1+
# Byte-compiled / optimized / DLL files
32
__pycache__/
43
*.pyc
4+
*.py[cod]
5+
*$py.class
6+
7+
# C extensions
8+
*.so
9+
10+
# Distribution / packaging
11+
.Python
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
pip-wheel-metadata/
25+
share/python-wheels/
26+
*.egg-info/
27+
.installed.cfg
28+
*.egg
29+
MANIFEST
30+
31+
# PyInstaller
32+
# Usually these files are written by a python script from a template
33+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
34+
*.manifest
35+
*.spec
36+
37+
# Installer logs
38+
pip-log.txt
39+
pip-delete-this-directory.txt
40+
41+
# Unit test / coverage reports
42+
htmlcov/
43+
.tox/
44+
.nox/
45+
.coverage
46+
.coverage.*
47+
.cache
48+
nosetests.xml
49+
coverage.xml
50+
*.cover
51+
*.py,cover
52+
.hypothesis/
53+
.pytest_cache/
54+
55+
# Translations
56+
*.mo
57+
*.pot
58+
59+
# Django stuff:
60+
*.log
61+
local_settings.py
62+
db.sqlite3
63+
db.sqlite3-journal
64+
65+
# Flask stuff:
66+
instance/
67+
.webassets-cache
68+
69+
# Scrapy stuff:
70+
.scrapy
71+
72+
# Sphinx documentation
73+
docs/_build/
74+
75+
# PyBuilder
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
.python-version
87+
88+
# pipenv
89+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
90+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
91+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
92+
# install all needed dependencies.
93+
#Pipfile.lock
94+
95+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
96+
__pypackages__/
97+
98+
# Celery stuff
99+
celerybeat-schedule
100+
celerybeat.pid
101+
102+
# SageMath parsed files
103+
*.sage.py
104+
105+
# Environments
106+
.env
107+
.venv
108+
env/
109+
venv/
110+
ENV/
111+
env.bak/
112+
venv.bak/
113+
114+
# Spyder project settings
115+
.spyderproject
116+
.spyproject
117+
118+
# Rope project settings
119+
.ropeproject
120+
121+
# mkdocs documentation
122+
/site
123+
124+
# mypy
125+
.mypy_cache/
126+
.dmypy.json
127+
dmypy.json
128+
129+
# Pyre type checker
130+
.pyre/

‎README.rst

+15-49
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,33 @@
22
README
33
######
44

5-
IoTStubEssentials
6-
*****************
5+
ProjectEssentials-Python
6+
************************
77
.. Brief description of project, what it is used for.
8-
This is collection of essential components required for IoT stubs in projects.
8+
This is collection of essential components required in multiple python
9+
projects.
910

1011
Installing / Getting started
1112
============================
1213
.. Introduction of minimal setup.
1314
Command, followed by explanation in next paragraph or after every command.
14-
To use components, just copy ``src/`` or ``clone`` this repository and get
15-
started.
15+
* `src <https://github.com/CXINFINITE/ProjectEssentials-Python/blob/main/src>`_
16+
contains various directories containing various components.
1617

17-
For GitHub commands, check ``Documentation/GitHubUsage.rst``.
18+
* Each have their own set of requirements and (independent) source codes.
19+
20+
* For GitHub related commands, check `docs/ <https://github.com/CXINFINITE/ProjectEssentials-Python/blob/main/docs/GitHubUsage.rst>`_.
1821

1922
Developing
2023
==========
2124
Built with
2225
----------
2326
.. List of main libraries, frameworks used including versions.
24-
Python.
25-
26-
Prerequisites
27-
-------------
28-
.. What is needed to set up dev environment.
29-
For instances, dependencies or tools include download links.
30-
Standalone.
31-
32-
Setting up dev
33-
--------------
34-
.. Brief intro of what to do to start developing.
35-
Commands with explanations as well.
36-
Fork this repository and start developing.
37-
38-
Building
39-
--------
40-
.. How to build the project after working on it.
41-
Commands and explanation.
42-
* Test individual components and components that rely on them.
43-
* If test passed, it is ready to work.
27+
* Python >= 3.8.x.
28+
* For other dependencies check individual ``requirements.txt`` in respective
29+
directories under `src/ <https://github.com/CXINFINITE/ProjectEssentials-Python/blob/main/src>`_.
30+
* Examples provided under `examples/ <https://github.com/CXINFINITE/ProjectEssentials-Python/blob/main/examples>`_ have their own set of ``requirements.txt``
31+
under respective directories.
4432

4533
Deploying / Publishing
4634
----------------------
@@ -53,34 +41,12 @@ Versioning
5341
.. SemVer versioning info, link to other versions.
5442
0.0 - dev.
5543

56-
Configuration
57-
=============
58-
.. Configurations a user can enter when using the project.
59-
None required.
60-
61-
Tests
62-
=====
63-
.. Describe and show how to run tests with examples. Also, explain them with
64-
reasons.
65-
Does not contain tests, but will be added later.
66-
6744
Style guide
6845
===========
6946
.. Coding style and how to check it.
7047
Follows ``PEP 8`` python style guide.
7148

72-
API Reference
73-
=============
74-
.. Links to API documentation, description, explanation.
75-
None.
76-
77-
Database
78-
========
79-
.. Database versions and usages with download links.
80-
Also include DB Schema, relations, etc.
81-
None.
82-
8349
Licensing
8450
=========
8551
.. State license and link to text version.
86-
Check ``LICENSE``.
52+
Check `LICENSE <https://github.com/CXINFINITE/ProjectEssentials-Python/blob/main/LICENSE>`_.

‎Configuration/VIM.vimrc renamed to ‎config/vimrc

File renamed without changes.

‎Documentation/Contributing.rst renamed to ‎docs/Contributing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ Pull requests
2424

2525
Working with GitHub
2626
===================
27-
Check ``Documentation/GitHubUsage.rst`` for how to perform various tasks.
27+
Check `docs/GitHubUsage.rst <https://github.com/CXINFINITE/ProjectEssentials-Python/blob/main/docs/GitHubUsage.rst>`_ for how to perform various git related operations.

‎Documentation/GitHubUsage.rst renamed to ‎docs/GitHubUsage.rst

+8
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,11 @@ Pushing changes to remote
4646
and *branch*.
4747
* ``git push`` to push to currently set *remote* and *branch*.
4848

49+
Updating local while preserving untracked
50+
=========================================
51+
1. ``git fetch origin`` to fetch changes from repository.
52+
2. ``git pull`` to merge changes, without affecting local modified files.
53+
4954
Rebasing for merge conflict
5055
===========================
5156
1. ``git fetch upstream`` to fetch updated file(s) from upstream.
@@ -137,9 +142,12 @@ Parallelly working on multiple branches
137142

138143
GitHub website
139144
**************
145+
.. Put content here.
140146
141147
GitHub CLI
142148
**********
149+
.. Put content here.
143150
144151
GitHub GUI
145152
**********
153+
.. Put content here.

‎examples/BrythonSPA-UAPI-Django/BrythonModulesUpdater.py

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import BrythonModulesUpdater as App
2+
3+
if __name__ == '__main__':
4+
App.core.Executor.execute_from_cli()
5+
exit(0)

‎examples/BrythonSPA-UAPI-Django/BrythonModulesUpdater/__init__.py

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
from .argParser import ArgParser
2+
from .brythonModules import BrythonModules
3+
from .configuration import Configuration
4+
from .osCommands import OSCommands
5+
from .isolation import Isolation
6+
7+
from . import (
8+
core,
9+
)
10+
11+
__all__ = [
12+
'core',
13+
'ArgParser',
14+
'BrythonModules',
15+
'Configuration',
16+
'OSCommands',
17+
'Isolation',
18+
]

0 commit comments

Comments
 (0)