Skip to content
This repository has been archived by the owner on Nov 23, 2021. It is now read-only.

Q4 review #169

Open
wants to merge 34 commits into
base: Q4-review
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
35ba063
Create React App
Dev-Dominic Aug 15, 2020
fc03c98
Updated gitignore for node_modules
Dev-Dominic Aug 15, 2020
e273c78
Remove old python tests
Dev-Dominic Aug 15, 2020
b332e68
Structure React App
Dev-Dominic Aug 20, 2020
303714d
Login Route Design Complete
Dev-Dominic Aug 20, 2020
f8cd1e0
Start design of sidebar component
Dev-Dominic Aug 20, 2020
77a7054
Sidebar and Dashboard started
Dev-Dominic Aug 21, 2020
ee0fe8e
Restructure and Routing Init
Dev-Dominic Aug 24, 2020
0bf5986
Setup preliminary routes
Dev-Dominic Aug 24, 2020
662ad2b
Refactor exisiting components and routes
Dev-Dominic Aug 25, 2020
6ec1e71
Create `Base` application template
Dev-Dominic Aug 25, 2020
3ae074c
Dashboard Initial front-end design
Dev-Dominic Aug 25, 2020
6f25e81
Change route.js to routes.js
Dev-Dominic Aug 25, 2020
cbeed13
Updates to dashboard layout and graphql client setup
Dev-Dominic Aug 26, 2020
0eecd07
Implement GraphQL Client-Side Querying
Dev-Dominic Aug 27, 2020
9600798
Pattoo-web colorscheme
Dev-Dominic Aug 27, 2020
8980b5a
Updates to design
Dev-Dominic Aug 28, 2020
f7af8df
Updates queries and addition of api file for queries
Dev-Dominic Aug 29, 2020
829243a
Query for User Chart Favorites
Dev-Dominic Aug 30, 2020
ba4f34a
Re-design and Colorizing
Dev-Dominic Aug 30, 2020
e64e285
Create Chart Modal
Dev-Dominic Aug 31, 2020
1311c14
Setup Create Chart form
Dev-Dominic Sep 1, 2020
1b397bd
Update README
Dev-Dominic Sep 1, 2020
7f7bcbb
Allow for creating new charts and favorites
Dev-Dominic Sep 1, 2020
1ca31b7
Updated File Structure (#166)
Dev-Dominic Sep 24, 2020
b187cf1
Fix Module Imports
Dev-Dominic Sep 26, 2020
b266592
Update Project import system (#166)
Dev-Dominic Sep 27, 2020
82d070d
Update Project Structure and Docs
Dev-Dominic Oct 3, 2020
890b712
Update travis config for ReactJs testing
Dev-Dominic Oct 24, 2020
38a974f
Fix typo in travis config
Dev-Dominic Oct 24, 2020
1a178d1
Additional updates to travis config
Dev-Dominic Oct 24, 2020
a7e5037
Clean-up files for new production
Dev-Dominic Oct 25, 2020
759abc7
Old build
Dev-Dominic Oct 25, 2020
34e8c14
Resolve merge conflicts
Dev-Dominic Oct 25, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
25 changes: 25 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"extends": [
"eslint: recommended",
"plugin: import/errors",
"plugin:react/recommended",
"plugin: jsx-a11y/recommended",
"prettier",
"prettier/react"
],
"plugins": ["react", "import", "jsx-a11y"],
"env": {
"browser": true,
"es2020": true
},
"extends": ["eslint:recommended", "plugin:react/recommended"],
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": 11,
"sourceType": "module"
},
"plugins": ["react"],
"rules": {}
}
165 changes: 18 additions & 147 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,152 +1,23 @@
###############################################################################
# Pattoo exlcusions
###############################################################################
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# Ignore files in these directories and ALL subdirectories
# _AND_ maintain the directory structure
# dependencies
/node_modules
/.pnp
.pnp.js

etc/**
!etc/.gitkeep
log/**
!log/.gitkeep
cache/**
!cache/.gitkeep
daemon/**
!daemon/.gitkeep
# testing
/coverage

###############################################################################
# Vim editor files
###############################################################################
# production
/build

# Created by https://www.gitignore.io/api/vim
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

### Vim ###
# Swap
[._]*.s[a-v][a-z]
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]

# Session
Session.vim
Sessionx.vim

# Temporary
.netrwhist
*~
# Auto-generated tag files
tags
# Persistent undo
[._]*.un~

# End of https://www.gitignore.io/api/vim

###############################################################################
# Generic Python Exlcusions (Provided by GitHub)
###############################################################################

# 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/
*.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/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

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

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# 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/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
41 changes: 13 additions & 28 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,16 @@
# Run on ubuntu
dist: bionic
language: node_js
node_js:
- 14

# Don't use
sudo: false
# Caches dependencies
cache:
directories:
- node_modules

# Define the language and versions that infoset is written in
language: python
python:
- 3.6
# Installs all require modules before testing
before_script:
- npm install

# Run tests only against the master branch
# branches:
# only:
# - master

# Setup services
services:
- mysql

# Setup global environmental variables
env:
- PYTHONPATH=./ PATTOO_CONFIGDIR=$HOME/.pattoo-web-unittests/config

# Install PIP packages and create a temporary config file before installing
before_install:
- pip install -r pip_requirements.txt
- tests/bin/unittest_setup.py

# Run the unittest scripts
script: tests/bin/do_all_tests.py
# Runs all unittests
script:
- npm run test
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ pattoo-web

``pattoo-web`` is a web GUI to view IoT data stored on ``pattoo`` servers.

Setup and Running pattoo-web
============================

`Pattoo-web` udpated to run as ReactJS application and utilizes various
third-party ReactJS modules.

.. code-block:: bash

cd pattoo_web
npm install
npm start


Introduction
============

Expand Down
54 changes: 0 additions & 54 deletions bin/pattoo_webd.py

This file was deleted.

3 changes: 0 additions & 3 deletions cache/.gitkeep

This file was deleted.

3 changes: 0 additions & 3 deletions daemon/.gitkeep

This file was deleted.

Binary file added docs/_build/doctrees/about.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/backup.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/configuration.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/contributing.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/cron.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/installation.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/pattoo_webd.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/project-structure.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/troubleshooting.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e69da40af2d1b12af555ce522485c62f
tags: 645f666f9bcd5a90fca523b33c5a78b7
27 changes: 27 additions & 0 deletions docs/_build/html/_sources/about.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
About Pattoo
============

``pattoo`` allows you to use your web browser to chart your organization's constantly changing data.

It was inspired by the need to collect and visualize data from various DevOps, network, industrial PLC controllers, electro-mechanical and enterprise systems on a single web dashboard.

This data is collected by ``pattoo`` agents. There are standard agents for:

* Linux
* SNMP
* Modbus TCP
* Bacnet/IP
* OPC UA

With programming skill, you can create your own custom agents if needed.

Operational Overview
--------------------

``pattoo`` has a number of inter-related components. `You can see how they all work together on the pattoo web page. <https://palisadoesfoundation.github.io/pattoo.github.io/>`_


The Palisadoes Foundation
-------------------------

``pattoo`` is based on the original ``infoset`` code created by the `Palisadoes Foundation <http://www.palisadoes.org>`_ as part of its annual Calico Challenge program. Calico provides paid summer internships for Jamaican university students to work on selected open source projects. They are mentored by software professionals and receive stipends based on the completion of predefined milestones. Calico was started in 2015.
29 changes: 29 additions & 0 deletions docs/_build/html/_sources/backup.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Backup and Restoration
======================

Always take precautions. Backup your data as you'll never know when you'll need to restore it.

Backup
------

It is strongly advised that you backup your agents to protect you in the event of catastrophe.

The following directories need to be saved periodically.

#. The ``PATTOO_CONFIGDIR`` directory which contains your configuration
#. The ``daemon_directory`` location defined in your configuration. This area stores important authentication information.
#. The ``pattoo-agents`` directory which contains your source code.

We'll discuss data restoration next.

Restoration
-----------

It's important to follow these steps in this order when restoring ``pattoo-agents`` after a disaster.

#. FIRST make sure all the ``pattoo`` agents are stopped.
#. SECOND restore the contents of the ``daemon_directory`` location defined in your configuration. This area stores important authentication information.
#. Restore the ``PATTOO_CONFIGDIR`` directory which contains your configuration
#. Restore ``pattoo-agents`` directory which contains your source code.

You should now be able to restart your agents without issue.
Loading