nest_backend - Web API in PythonIl progetto¶
+N.E.S.T. (Noi Estraiamo Statistiche Tweet) è un progetto realizzato nel 2021 per +l”esame di Progetto del Software del corso di Informatica all’Unimore.
+
+
+
Suddivisione in moduli¶
+Il progetto è composto da tre parti:
+-
+
nest_crawlerUn modulo scritto in Python usando
+tweepyche recupera tweet attraverso la Twitter API secondo le +condizioni presenti all’interno del database e li salva per future elaborazioni.
+nest_backendUn web server scritto in Python usando il framework
+flaskche fornisce un’API HTTP per visualizzare e +manipolare i dati dell’applicazione, gestendo autenticazione, autorizzazione e comunicazione con il database.
+nest_frontendUna applicazione web scritta in JSX usando il framework
+reactche comunica con il backend, mostrando +all’utente i dati del backend in una formato immediatamente comprensibile.
+
+
+
+
+
+user¶
+-
+
-
+
to_json()¶
+
-
__init__(**kwargs)¶
@@ -679,6 +684,16 @@ for example, any mapped columns or relationships.
insert_time¶
-
+
-
+
post_time¶
+
-
+
-
+
image_url¶
+
-
repositories¶
diff --git a/docs/build/html/development/log.html b/docs/build/html/development/log.html
index e6fca65..60a1c02 100644
--- a/docs/build/html/development/log.html
+++ b/docs/build/html/development/log.html
@@ -102,38 +102,38 @@
- Riunioni collettive
- Attività individuali
-
-
- Stefano Goldoni - Product Owner -
- Flavia Cocca - Scrum Master -
- Chiara Calzolari - UI/UX Designer -
- Stefano Pigozzi - Frontend Developer & Sysadmin +
- Stefano Goldoni - Product Owner & Tester +
- Flavia Cocca - Scrum Master & UI Designer +
- Chiara Calzolari - UI Designer +
- Stefano Pigozzi - Sysadmin & Frontend Developer
-
-
- Riunioni collettive -
- Attività individuali
-
-
- Stefano Goldoni - Product Owner +
- Riunioni collettive +
- Attività individuali
-
+
- Stefano Goldoni - Product Owner & Tester
- Giovanni Anniballi - Tester -
- Giorgio Minoccari - Sviluppatore Backend -
- Lorenzo Balugani - Developer -
- FLavia Cocca - Scrum Master -
- Chiara Calzolari - UI Designer -
- Stefano Pigozzi - Frontend Developer +
- Giorgio Minoccari - Analyst & Backend Developer +
- Lorenzo Balugani - DB & Backend Developer +
- FLavia Cocca - Scrum Master & UI Designer +
- Chiara Calzolari - UI Designer +
- Stefano Pigozzi - Sysadmin & Frontend Developer
- Sprint 2
-
-
- Riunioni collettive -
- Attività individuali
-
-
- Chiara Calzolari - UI Designer -
- Stefano Goldoni - Product Owner & Tester -
- Lorenzo Balugani - DB & Backend Developer -
- Stefano Pigozzi - Sysadmin & Frontend Developer -
- Flavia Cocca - Scrum Master & UI Designer -
- Giovanni Anniballi - Tester -
- Giorgio Minoccari - Analyst & Backend Developer +
- Riunioni collettive +
- Attività individuali
Registro attività¶
--Da fare
-Mettere titoli personali uguali in tutti gli sprint per consistenza.
-Sprint 0¶
@@ -275,8 +271,8 @@Attività individuali¶
--Stefano Goldoni - Product Owner¶
++-Stefano Goldoni - Product Owner & Tester¶
@@ -321,8 +317,8 @@ -Flavia Cocca - Scrum Master¶
++-Flavia Cocca - Scrum Master & UI Designer¶
@@ -371,8 +367,8 @@ -Chiara Calzolari - UI/UX Designer¶
++-Chiara Calzolari - UI Designer¶
@@ -429,19 +425,70 @@ -Stefano Pigozzi - Frontend Developer & Sysadmin¶
--+Da fare
-Compilare con i dati di Toggl!
-+Stefano Pigozzi - Sysadmin & Frontend Developer¶
++
+ + ++ + + Data
Durata
Attività
+ + Totale
2021-04-02
1.5h
Studio
2021-04-08
4.5h
Configurazione Discord e GitLab
2021-04-09
3.5h
Riunione con il cliente e configurazione Taiga
2021-04-10
4.0h
Configurazione Penpot, Taiga, UI Design, progettazione Database
2021-04-11
3.5h
Riunione, configurazione GitLab e project management
2021-04-12
0.5h
Configurazione Twitter e UI Design
2021-04-15
2.5h
Partita a Scrumble e project management
2021-04-16
1.5h
Project management e configurazione SonarQube
2021-04-17
3.5h
Riunione e partita a scrumble
Sprint 1¶
--Riunioni collettive¶
++-Riunioni collettive¶
@@ -465,10 +512,10 @@ -Attività individuali¶
--Stefano Goldoni - Product Owner¶
++Attività individuali¶
++-Stefano Goldoni - Product Owner & Tester¶
@@ -588,8 +635,8 @@ -Giorgio Minoccari - Sviluppatore Backend¶
++-Giorgio Minoccari - Analyst & Backend Developer¶
Durante lo sprint ho principalmente svolto sviluppo e test riguardo alla API di twitter, in modo da poter effettuare chiamate efficenti e non venire limitati dal sito riguardo alle richieste effettuate.
@@ -643,8 +690,8 @@ -Lorenzo Balugani - Developer¶
++-Lorenzo Balugani - DB & Backend Developer¶
@@ -705,8 +752,8 @@ -FLavia Cocca - Scrum Master¶
++-FLavia Cocca - Scrum Master & UI Designer¶
@@ -743,8 +790,8 @@ Sprint 2¶
--Riunioni collettive¶
+++Riunioni collettive¶
@@ -813,10 +923,10 @@ +Attività individuali¶
-Attività individuali¶
- --Stefano Goldoni - Product Owner & Tester¶
++-Stefano Goldoni - Product Owner & Tester¶
@@ -915,8 +1025,8 @@ -Lorenzo Balugani - DB & Backend Developer¶
++-Lorenzo Balugani - DB & Backend Developer¶
@@ -969,8 +1079,8 @@ -Stefano Pigozzi - Sysadmin & Frontend Developer¶
++-Stefano Pigozzi - Sysadmin & Frontend Developer¶
@@ -1115,8 +1225,8 @@ -Flavia Cocca - Scrum Master & UI Designer¶
++-Flavia Cocca - Scrum Master & UI Designer¶
@@ -1173,8 +1283,8 @@ -Giovanni Anniballi - Tester¶
++-Giovanni Anniballi - Tester¶
@@ -1235,8 +1345,8 @@ -Giorgio Minoccari - Analyst & Backend Developer¶
++Giorgio Minoccari - Analyst & Backend Developer¶
@@ -1281,7 +1391,7 @@ Sprint 3¶
-+diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index aa94ddb..8f86d3f 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -380,6 +380,8 @@Da fare
Compilare il registro attività dello sprint 3.
@@ -603,6 +607,8 @@ - to_json() (nest_backend.database.tables.Alert metodo)
-
+
- (nest_backend.database.tables.Authorization metodo) +
- (nest_backend.database.tables.Condition metodo)
- (nest_backend.database.tables.Notification metodo)
diff --git a/docs/build/html/index.html b/docs/build/html/index.html
index 18c4ba3..b9d2209 100644
--- a/docs/build/html/index.html
+++ b/docs/build/html/index.html
@@ -178,7 +178,11 @@
Manuale utente
-
-
- Il progetto +
- Il progetto +
- Installazione
- Prerequisiti
- Creare un nuovo utente diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index 5512602..72772e4 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 91afce2..cc8408e 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["about/index","backend/index","crawler/index","development/client/index","development/log","development/stats/index","development/tools","frontend/index","index","installation/index","meta/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,sphinx:56},filenames:["about/index.rst","backend/index.rst","crawler/index.rst","development/client/index.rst","development/log.rst","development/stats/index.rst","development/tools.rst","frontend/index.rst","index.rst","installation/index.rst","meta/index.rst"],objects:{"":{nest_backend:[1,0,0,"-"],nest_crawler:[2,0,0,"-"]},"nest_backend.database":{base:[1,0,0,"-"],tables:[1,0,0,"-"]},"nest_backend.database.tables":{Alert:[1,1,1,""],Authorization:[1,1,1,""],Composed:[1,1,1,""],Condition:[1,1,1,""],ConditionMode:[1,1,1,""],ConditionType:[1,1,1,""],Contains:[1,1,1,""],MadeOf:[1,1,1,""],Notification:[1,1,1,""],OperationType:[1,1,1,""],Repository:[1,1,1,""],Tweet:[1,1,1,""],User:[1,1,1,""]},"nest_backend.database.tables.Alert":{__init__:[1,2,1,""],conditions:[1,3,1,""],evaluation_mode:[1,3,1,""],id:[1,3,1,""],limit:[1,3,1,""],name:[1,3,1,""],notifications:[1,3,1,""],repository:[1,3,1,""],repository_id:[1,3,1,""],to_json:[1,2,1,""],window_size:[1,3,1,""]},"nest_backend.database.tables.Authorization":{__init__:[1,2,1,""],email:[1,3,1,""],repository:[1,3,1,""],rid:[1,3,1,""],user:[1,3,1,""]},"nest_backend.database.tables.Composed":{__init__:[1,2,1,""],repository:[1,3,1,""],rid:[1,3,1,""],snowflake:[1,3,1,""],tweet:[1,3,1,""]},"nest_backend.database.tables.Condition":{__init__:[1,2,1,""],alerts:[1,3,1,""],content:[1,3,1,""],id:[1,3,1,""],repository:[1,3,1,""],repository_id:[1,3,1,""],to_json:[1,2,1,""],tweets:[1,3,1,""],type:[1,3,1,""]},"nest_backend.database.tables.ConditionMode":{all_and:[1,3,1,""],all_or:[1,3,1,""]},"nest_backend.database.tables.ConditionType":{coordinates:[1,3,1,""],hashtag:[1,3,1,""],location:[1,3,1,""],place:[1,3,1,""],time:[1,3,1,""],user:[1,3,1,""]},"nest_backend.database.tables.Contains":{__init__:[1,2,1,""],cid:[1,3,1,""],condition:[1,3,1,""],snowflake:[1,3,1,""],tweet:[1,3,1,""]},"nest_backend.database.tables.MadeOf":{__init__:[1,2,1,""],aid:[1,3,1,""],alert:[1,3,1,""],cid:[1,3,1,""],condition:[1,3,1,""]},"nest_backend.database.tables.Notification":{__init__:[1,2,1,""],alert:[1,3,1,""],alert_id:[1,3,1,""],id:[1,3,1,""],ora:[1,3,1,""],to_json:[1,2,1,""]},"nest_backend.database.tables.OperationType":{assign:[1,3,1,""]},"nest_backend.database.tables.Repository":{__init__:[1,2,1,""],alerts:[1,3,1,""],authorizations:[1,3,1,""],conditions:[1,3,1,""],end:[1,3,1,""],evaluation_mode:[1,3,1,""],id:[1,3,1,""],is_active:[1,3,1,""],name:[1,3,1,""],owner:[1,3,1,""],owner_id:[1,3,1,""],start:[1,3,1,""],to_json:[1,2,1,""],tweets:[1,3,1,""]},"nest_backend.database.tables.Tweet":{__init__:[1,2,1,""],conditions:[1,3,1,""],content:[1,3,1,""],insert_time:[1,3,1,""],location:[1,3,1,""],place:[1,3,1,""],poster:[1,3,1,""],repositories:[1,3,1,""],snowflake:[1,3,1,""],to_json:[1,2,1,""]},"nest_backend.database.tables.User":{__init__:[1,2,1,""],authorizations:[1,3,1,""],email:[1,3,1,""],isAdmin:[1,3,1,""],owner_of:[1,3,1,""],password:[1,3,1,""],to_json:[1,2,1,""],username:[1,3,1,""]},"nest_backend.gestione":{admin_or_403:[1,4,1,""],authenticate:[1,4,1,""],error_handler:[1,4,1,""],find_user:[1,4,1,""],gen_password:[1,4,1,""],hashtag_validator:[1,4,1,""],identity:[1,4,1,""],json_error:[1,4,1,""],json_request_authorizer:[1,4,1,""],json_success:[1,4,1,""],repository_auth:[1,4,1,""]},nest_backend:{database:[1,0,0,"-"],gestione:[1,0,0,"-"]}},objnames:{"0":["py","module","Python modulo"],"1":["py","class","Python classe"],"2":["py","method","Python metodo"],"3":["py","attribute","Python attributo"],"4":["py","function","Python funzione"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"00h":4,"03h":4,"04h":4,"09h":4,"10h":4,"11h":4,"127":9,"13h":4,"15h":4,"17h":4,"18h":4,"2021":4,"20h":4,"21h":4,"248":9,"25h":4,"29h":4,"30040":9,"30041":9,"301":9,"34h":4,"35m":4,"39h":4,"39m":4,"40h":4,"443":9,"44h":4,"45h":4,"47h":4,"51h":4,"52m":4,"57h":4,"63072000":9,"7c2fm2vd":9,"class":1,"else":1,"enum":1,"for":1,"function":1,"gi\u00e0":4,"return":1,"short":[],"this":[1,9],"var":[4,9],None:1,Per:[4,9],Una:[9,10],__init__:1,abil:9,according:1,acme:9,actually:1,adatt:9,adds:1,adegu:4,admin_or_403:1,after:9,age:9,aggiung:[3,5],aggiunt:4,aggreg:4,aid:1,alcun:[4,9],alert:[1,4],alert_id:1,alerts:[1,4],all_and:1,all_or:1,allowed:1,allows:1,almen:10,alon:1,altre:4,always:9,ambient:4,amministr:9,analis:4,ancor:9,and:1,andrann:4,any:1,apac:8,api:[4,8,9],app:9,application:1,appost:9,approcc:4,arch:9,are:1,assign:1,attiv:[8,9],attributes:1,autent:4,authentic:1,authentication:1,authorization:1,authorizations:1,automat:9,aver:9,avvi:9,backend:8,background:9,backlog:4,bas:[4,8],based:9,bash:9,basic:10,bat:10,becaus:1,benven:8,bin:9,brainstorming:4,bug:4,bugfixing:4,build:[5,9,10],cach:9,cancell:4,cap:4,cartell:[9,10],cas:9,cases:4,casual:9,cattur:4,cer:9,cerc:8,checks:1,chiam:4,chiav:4,chown:9,cid:1,classes:1,client:[4,8],clon:9,cod:1,codic:[4,5,8],columns:1,com:[5,8,10],comand:9,combination:1,compil:[4,8],compless:[4,9],complet:4,component:4,composed:1,conclusion:4,condition:1,conditionmod:1,conditions:[1,4],conditiontyp:1,condizion:4,config:9,configur:[4,8],configuration:10,connession:9,consegn:8,consigl:9,consistent:4,constructed:1,constructor:1,cont:5,contains:1,conten:9,contenent:5,content:1,continuous:10,controll:4,coordinates:1,cop:9,cor:9,correct:1,corrett:9,correzion:4,cors:4,cos:10,costant:9,could:1,coverag:4,crawler:8,cre:8,createdb:9,createuser:9,creating:9,creazion:4,credentials:1,css:4,curl:9,dark:4,dashboard:4,dat:[1,4,9,10],databas:[4,8],dbms:9,deb:4,decl_ap:1,declar:1,definit:4,definizion:4,dem:[4,9],denomin:9,depends:1,description:9,descrizion:3,dettagl:9,development:[],diagramm:4,dipendent:[8,10],dir:9,directory:[5,9,10],dirett:9,discussion:4,dispon:[4,9,10],disponessim:10,distribu:9,divers:4,doa:9,docs:[5,9,10],document:[4,5],documentation:10,dop:9,doppiagg:4,dovr:9,dovrebb:9,dsjiofgvinmodfiojvbnio3erfnoiweraqugu43ghjwrevniuwerng43iugnreuwignhritmj43i43nb8i42ug0wevkwovmwigtjj:9,dur:4,durant:4,edit:9,effettu:4,efficent:4,elenc:4,elimin:4,email:1,enabl:9,end:1,engines:9,entit:4,entrarv:9,entri:10,enumeration:1,env:9,environment:[9,10],epic:4,error:[1,4],error_handler:1,errorunknownerror:1,esecu:9,esegu:[9,10],esemp:[4,9],espost:9,esse:4,esser:9,estension:8,evaluation_mod:1,exampl:1,exec:9,execstart:9,explorer:4,expr:9,fact:1,fallimentar:4,fancy:1,farl:9,feedback:8,figm:4,fil:[5,8],fin:[4,9],finc:9,find_user:1,fix:4,fixtures:4,flask:8,flask_config:9,forc:9,format:1,formatted:1,forn:9,forwarded:9,foss:10,fram:4,from:1,frontend:8,full:9,fullchain:9,funzion:4,gen_password:1,gener:[4,5,9,10],general:4,generates:1,geolocalizz:4,gest:9,gestion:[4,8],git:9,github:10,gitinspector:8,gitlab:[1,4,9],gnu:8,gratuit:4,graz:4,grooming:4,group:9,guid:9,gunicorn:9,happy:1,hash:1,hashed:1,hashtag:[1,4],hashtag_validator:1,header:9,hom:9,html:[9,10],http:9,http_host:9,https:9,ide:[4,8],identity:1,illustr:9,implement:4,imports:1,impost:9,inaccur:5,incontr:4,index:[],indic:8,indirizz:9,inerent:4,infin:10,info:4,inform:9,initialization:1,inizial:3,inser:[4,9],insert_tim:1,install:[8,10],instanc:1,integr:[4,9,10],intellij:8,inter:9,interfacc:8,intern:[9,10],internet:9,interv:4,inutil:4,is_act:1,isadmin:1,isol:9,issu:4,issues:4,ital:4,its:1,json:[1,4,9],json_error:1,json_request_authorizer:1,json_success:1,jwt:[1,9],key:9,keys:1,kwargs:1,lasc:4,lavor:4,leg:4,librer:9,licenz:10,light:4,limit:[1,4],linux:[9,10],littl:1,local:[4,9],location:1,log:4,logg:4,login:[1,4],lookup:9,loopback:9,madeof:1,maggior:9,mak:8,makefil:10,manag:4,management:4,mancant:[3,5],manten:9,manual:[9,10],many:1,mapped:1,matc:1,max:9,mentr:10,messag:1,met:8,method:1,metod:[4,8],mett:4,miglior:4,missirol:5,mkdir:9,mockup:4,mod:[4,9],model:1,modic:4,modif:4,modul:[1,4,8],molt:[5,9],moment:4,mot:9,msg:1,mult:9,nam:1,names:1,necess:9,necessar:[9,10],needs:1,nest:9,nest_backend:[8,9],nest_crawler:8,nest_frontend:8,network:9,node_env:9,node_modules:9,node_version:9,nodejs:8,nom:[4,9],nonexisting:[],not:1,notification:1,notifications:[1,4],npm:9,nss:9,nuov:[4,8],nvm:9,oauth:4,onlin:9,only:1,oper:9,operation:1,operationtyp:1,ora:[1,4,9],org:9,organizz:4,orm:1,ospit:10,ottimizz:9,output:4,owner:[1,9],owner_id:1,owner_of:1,pacchett:9,pagin:4,pair:4,param:1,parametr:10,parents:9,parol:4,part:4,particol:10,pass:4,password:1,payload:1,perc:[4,9],percors:[8,9],permett:10,personal:4,pertant:9,piccol:4,pien:9,plac:1,place_id:4,planning:4,platform:1,plugin:4,poetry:[9,10],poi:10,poker:4,port:9,poss:9,possibil:[9,10],poster:1,postgres:9,postgresql:9,poter:4,powershell:8,precedent:9,predisposizion:4,preferibil:9,prem:9,prepar:4,prerequis:8,present:[1,4],prim:[4,9,10],principal:4,probabil:5,prod:9,prodott:3,production:9,prof:5,progett:[4,9,10],programming:4,project:4,propr:9,propriet:4,prosegu:9,prot:9,protocols:9,prov:4,proxy:8,proxypass:9,proxypassrevers:9,pubblic:[4,9],put:4,py3:9,pypoetry:9,pytest:4,python:[8,10],qual:[4,9],qualor:10,quant:[5,9],quel:4,quell:4,query:4,quest:[5,9,10],rappresent:9,react:8,readthedocs:10,realizz:4,recurs:9,refactor:4,refactoring:4,referenc:[],registered:1,registr:8,relat:[4,10],relationships:1,relazion:4,rend:9,rep:4,repositories:[1,4],repository:[1,4],repository_auth:1,repository_id:1,reqest:1,request_schem:9,requestheader:9,required:1,resocont:4,rest:9,restitu:4,restructuredtext:10,ret:9,retrieval:4,retrospect:4,retrospett:4,returned:1,returns:1,revers:8,review:4,rewriteengin:9,rewriterul:9,riavv:9,ricerc:4,ricev:8,richiest:4,ricord:9,rid:1,rig:9,riguard:4,rimang:9,rimozion:4,risolt:4,risolu:4,ritocc:4,ritorn:4,riusc:4,root:9,routes:8,rp_app:9,run:[9,10],ruol:9,salv:9,sar:9,scanner:4,scaric:8,script:[9,10],scritt:[4,10],scrittur:4,scrumbl:4,secret_key:9,security:9,see:9,segnal:4,segret:9,seguent:9,sembr:5,serializabl:1,serv:9,server:[1,9],servernam:9,servic:9,serviz:8,session:4,set:9,sets:1,setting:4,settings:4,setup:[4,9],shar:4,shell:[9,10],shouldnt:1,sicurezz:9,simpl:1,sint:9,sistem:[9,10],sit:4,snowflak:1,sol:9,son:[5,9],sonarqub:4,sorgent:[8,10],sostitu:9,sourc:10,spec:1,specif:[1,4],specific:4,sphinx:10,sprint1:4,sprint2:4,sprint:[5,8],sqlalchemy:[1,9],sqlalchemy_database_ur:9,srs:4,srv:9,sslcertificatefil:9,sslcertificatekeyfil:9,sslengin:9,standard:10,standardizz:4,start:[1,9],stat:[4,5,9],statist:8,steff:9,stess:9,stesur:4,stories:4,strict:9,string:[1,9],strument:[8,10],struttur:[4,10],stud:4,success:9,successful:1,such:1,sugger:9,support:4,svolt:4,swagger:4,system:1,systemctl:9,systemd:8,tabell:8,tables:8,taig:4,talvolt:9,target:[9,10],tast:9,tastier:9,team:4,tecnic:4,ten:5,tentat:4,termin:4,test:[4,9],testing:4,tests:4,that:1,the:[1,9],thes:1,thing:1,thingamajigs:1,tim:1,tip:4,titl:[],titol:4,to_json:1,toctre:[],toggl:4,token:9,too:[],total:4,traduzion:4,tram:[4,9],transport:9,trov:10,tutt:[4,9],tweet:[1,4],tweets:1,twitter:4,type:[1,9],ugual:4,ulterior:4,ultim:[4,10],underlin:[],unit:9,usa:9,use:4,used:1,user:[1,4,9,10],useradd:9,usernam:1,users:4,using:1,uso:9,usr:9,utent:4,utility:8,utilizz:[4,8,9],valid:1,valu:1,values:1,valut:4,variabil:9,ved:[1,9],ven:4,vendored:5,veng:9,venv:[9,10],verif:9,verification:1,verr:9,version:[4,9,10],vide:4,vim:9,virtual:10,virtualenv:9,virtualenvs:9,virtualhost:9,volt:[4,10],want:1,wantedby:9,wants:9,was:1,web:[8,9],whether:1,window_siz:1,windows:8,working:9,workingdirectory:9,you:[1,9]},titles:["Il progetto","
nest_backend- Web API in Python","nest_crawler- Crawler in Python","Feedback ricevuto dal cliente","Registro attivit\u00e0","Statistiche di Gitinspector","Strumenti utilizzati","nest_frontend- Interfaccia utente in React","N.E.S.T.","Installazione","Meta-documentazione"],titleterms:{analyst:4,anniball:4,apac:9,api:1,attiv:4,autogener:8,backend:[4,9],balugan:4,bas:1,calzolar:4,chiar:4,client:3,cocc:4,codic:9,colleg:8,collett:4,com:9,compend:8,compil:[9,10],configur:9,consegn:3,crawler:[2,9],cre:9,databas:[1,9],designer:4,developer:4,dipendent:9,document:[3,8,10],estension:1,far:[3,4,5,9],feedback:3,fil:9,flask:1,flav:4,forn:[],frontend:[4,9],gestion:1,giorg:4,giovann:4,gitinspector:5,gnu:10,goldon:4,guid:8,ide:10,individual:4,inform:[],install:9,intellij:10,interfacc:7,lorenz:4,mak:10,manual:8,master:4,met:10,metod:1,minoccar:4,nest_backend:1,nest_crawler:2,nest_frontend:7,nodejs:9,nuov:9,owner:4,percors:1,pigozz:4,powershell:10,prerequis:9,product:4,progett:[0,8],proxy:9,python:[1,2,9],react:7,registr:4,revers:9,ricev:3,riunion:4,routes:1,scaric:9,scrum:4,serviz:9,sorgent:9,sprint:[3,4],statist:5,stef:4,strument:6,svilupp:[4,8],sysadmin:4,systemd:9,tabell:1,tables:1,tester:4,utent:[7,8,9],util:8,utility:1,utilizz:6,web:1,windows:10}}) \ No newline at end of file +Search.setIndex({docnames:["about/index","backend/index","crawler/index","development/client/index","development/log","development/stats/index","development/tools","frontend/index","index","installation/index","meta/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,sphinx:56},filenames:["about/index.rst","backend/index.rst","crawler/index.rst","development/client/index.rst","development/log.rst","development/stats/index.rst","development/tools.rst","frontend/index.rst","index.rst","installation/index.rst","meta/index.rst"],objects:{"":{nest_backend:[1,0,0,"-"],nest_crawler:[2,0,0,"-"]},"nest_backend.database":{base:[1,0,0,"-"],tables:[1,0,0,"-"]},"nest_backend.database.tables":{Alert:[1,1,1,""],Authorization:[1,1,1,""],Composed:[1,1,1,""],Condition:[1,1,1,""],ConditionMode:[1,1,1,""],ConditionType:[1,1,1,""],Contains:[1,1,1,""],MadeOf:[1,1,1,""],Notification:[1,1,1,""],OperationType:[1,1,1,""],Repository:[1,1,1,""],Tweet:[1,1,1,""],User:[1,1,1,""]},"nest_backend.database.tables.Alert":{__init__:[1,2,1,""],conditions:[1,3,1,""],evaluation_mode:[1,3,1,""],id:[1,3,1,""],limit:[1,3,1,""],name:[1,3,1,""],notifications:[1,3,1,""],repository:[1,3,1,""],repository_id:[1,3,1,""],to_json:[1,2,1,""],window_size:[1,3,1,""]},"nest_backend.database.tables.Authorization":{__init__:[1,2,1,""],email:[1,3,1,""],repository:[1,3,1,""],rid:[1,3,1,""],to_json:[1,2,1,""],user:[1,3,1,""]},"nest_backend.database.tables.Composed":{__init__:[1,2,1,""],repository:[1,3,1,""],rid:[1,3,1,""],snowflake:[1,3,1,""],tweet:[1,3,1,""]},"nest_backend.database.tables.Condition":{__init__:[1,2,1,""],alerts:[1,3,1,""],content:[1,3,1,""],id:[1,3,1,""],repository:[1,3,1,""],repository_id:[1,3,1,""],to_json:[1,2,1,""],tweets:[1,3,1,""],type:[1,3,1,""]},"nest_backend.database.tables.ConditionMode":{all_and:[1,3,1,""],all_or:[1,3,1,""]},"nest_backend.database.tables.ConditionType":{coordinates:[1,3,1,""],hashtag:[1,3,1,""],location:[1,3,1,""],place:[1,3,1,""],time:[1,3,1,""],user:[1,3,1,""]},"nest_backend.database.tables.Contains":{__init__:[1,2,1,""],cid:[1,3,1,""],condition:[1,3,1,""],snowflake:[1,3,1,""],tweet:[1,3,1,""]},"nest_backend.database.tables.MadeOf":{__init__:[1,2,1,""],aid:[1,3,1,""],alert:[1,3,1,""],cid:[1,3,1,""],condition:[1,3,1,""]},"nest_backend.database.tables.Notification":{__init__:[1,2,1,""],alert:[1,3,1,""],alert_id:[1,3,1,""],id:[1,3,1,""],ora:[1,3,1,""],to_json:[1,2,1,""]},"nest_backend.database.tables.OperationType":{assign:[1,3,1,""]},"nest_backend.database.tables.Repository":{__init__:[1,2,1,""],alerts:[1,3,1,""],authorizations:[1,3,1,""],conditions:[1,3,1,""],end:[1,3,1,""],evaluation_mode:[1,3,1,""],id:[1,3,1,""],is_active:[1,3,1,""],name:[1,3,1,""],owner:[1,3,1,""],owner_id:[1,3,1,""],start:[1,3,1,""],to_json:[1,2,1,""],tweets:[1,3,1,""]},"nest_backend.database.tables.Tweet":{__init__:[1,2,1,""],conditions:[1,3,1,""],content:[1,3,1,""],image_url:[1,3,1,""],insert_time:[1,3,1,""],location:[1,3,1,""],place:[1,3,1,""],post_time:[1,3,1,""],poster:[1,3,1,""],repositories:[1,3,1,""],snowflake:[1,3,1,""],to_json:[1,2,1,""]},"nest_backend.database.tables.User":{__init__:[1,2,1,""],authorizations:[1,3,1,""],email:[1,3,1,""],isAdmin:[1,3,1,""],owner_of:[1,3,1,""],password:[1,3,1,""],to_json:[1,2,1,""],username:[1,3,1,""]},"nest_backend.gestione":{admin_or_403:[1,4,1,""],authenticate:[1,4,1,""],error_handler:[1,4,1,""],find_user:[1,4,1,""],gen_password:[1,4,1,""],hashtag_validator:[1,4,1,""],identity:[1,4,1,""],json_error:[1,4,1,""],json_request_authorizer:[1,4,1,""],json_success:[1,4,1,""],repository_auth:[1,4,1,""]},nest_backend:{database:[1,0,0,"-"],gestione:[1,0,0,"-"]}},objnames:{"0":["py","module","Python modulo"],"1":["py","class","Python classe"],"2":["py","method","Python metodo"],"3":["py","attribute","Python attributo"],"4":["py","function","Python funzione"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"00h":4,"03h":4,"04h":4,"09h":4,"10h":4,"11h":4,"127":9,"13h":4,"15h":4,"17h":4,"18h":4,"2021":[0,4],"20h":4,"21h":4,"248":9,"25h":4,"29h":4,"30040":9,"30041":9,"301":9,"34h":4,"35m":4,"39h":4,"39m":4,"40h":4,"443":9,"44h":4,"45h":4,"47h":4,"51h":4,"52m":4,"57h":4,"63072000":9,"7c2fm2vd":9,"class":1,"else":1,"enum":1,"for":1,"function":1,"gi\u00e0":4,"return":1,"short":[],"this":[1,9],"var":[4,9],Noi:0,None:1,Per:[4,9],Una:[0,9,10],__init__:1,abil:9,according:1,acme:9,actually:1,adatt:9,adds:1,adegu:4,admin_or_403:1,after:9,age:9,aggiung:[3,5],aggiunt:4,aggreg:4,aid:1,alcun:[4,9],alert:[1,4],alert_id:1,alerts:[1,4],all_and:1,all_or:1,allowed:1,allows:1,almen:10,alon:1,altre:4,always:9,ambient:4,amministr:9,analis:4,ancor:9,and:1,andrann:4,any:1,apac:8,api:[0,4,8,9],app:9,applic:0,application:1,appost:9,approcc:4,arch:9,are:1,assign:1,attiv:[8,9],attravers:0,attributes:1,autent:[0,4],authentic:1,authentication:1,authorization:1,authorizations:1,automat:9,autorizz:0,aver:9,avvi:9,backend:[0,8],background:9,backlog:4,bas:[4,8],based:9,bash:9,basic:10,bat:10,becaus:1,benven:8,bin:9,brainstorming:4,bug:4,bugfixing:4,build:[5,9,10],cach:9,cancell:4,cap:4,cartell:[9,10],cas:9,cases:4,casual:9,cattur:4,cer:9,cerc:8,checks:1,chiam:4,chiav:4,chown:9,cid:1,classes:1,client:[4,8],clon:9,cod:1,codic:[4,5,8],columns:1,com:[5,8,10],comand:9,combination:1,compil:[4,8],compless:[4,9],complet:4,component:4,composed:1,compost:0,comprens:0,comun:0,conclusion:4,condition:1,conditionmod:1,conditions:[1,4],conditiontyp:1,condizion:[0,4],config:9,configur:[4,8],configuration:10,connession:9,consegn:8,consigl:9,consistent:[],constructed:1,constructor:1,cont:5,contains:1,conten:9,contenent:5,content:1,continuous:10,controll:4,coordinates:1,cop:9,cor:9,correct:1,corrett:9,correzion:4,cors:[0,4],cos:10,costant:9,could:1,coverag:4,crawler:8,cre:8,createdb:9,createuser:9,creating:9,creazion:4,credentials:1,css:4,curl:9,dark:4,dashboard:4,dat:[0,1,4,9,10],databas:[0,4,8],dbms:9,deb:4,decl_ap:1,declar:1,definit:4,definizion:4,dem:[4,9],denomin:9,depends:1,description:9,descrizion:3,design:4,dettagl:9,development:[],diagramm:4,dipendent:[8,10],dir:9,directory:[5,9,10],dirett:9,discord:4,discussion:4,dispon:[4,9,10],disponessim:10,distribu:9,divers:4,doa:9,docs:[5,9,10],document:[4,5],documentation:10,dop:9,doppiagg:4,dovr:9,dovrebb:9,dsjiofgvinmodfiojvbnio3erfnoiweraqugu43ghjwrevniuwerng43iugnreuwignhritmj43i43nb8i42ug0wevkwovmwigtjj:9,dur:4,durant:4,edit:9,effettu:4,efficent:4,elabor:0,elenc:4,elimin:4,email:1,enabl:9,end:1,engines:9,entit:4,entrarv:9,entri:10,enumeration:1,env:9,environment:[9,10],epic:4,error:[1,4],error_handler:1,errorunknownerror:1,esam:0,esecu:9,esegu:[9,10],esemp:[4,9],espost:9,esse:4,esser:9,estension:8,estraiam:0,evaluation_mod:1,exampl:1,exec:9,execstart:9,explorer:4,expr:9,fact:1,fallimentar:4,fancy:1,farl:9,feedback:8,figm:4,fil:[5,8],fin:[4,9],finc:9,find_user:1,fix:4,fixtures:4,flask:[0,8],flask_config:9,forc:9,form:0,format:1,formatted:1,forn:[0,9],forwarded:9,foss:10,fram:4,framework:0,from:1,frontend:8,full:9,fullchain:9,funzion:4,futur:0,gen_password:1,gener:[4,5,9,10],general:4,generates:1,geolocalizz:4,gest:[0,9],gestion:[4,8],git:9,github:10,gitinspector:8,gitlab:[1,4,9],gnu:8,gratuit:4,graz:4,grooming:4,group:9,guid:9,gunicorn:9,happy:1,hash:1,hashed:1,hashtag:[1,4],hashtag_validator:1,header:9,hom:9,html:[9,10],http:[0,9],http_host:9,https:9,ide:[4,8],identity:1,illustr:9,image_url:1,immediat:0,implement:4,imports:1,impost:9,inaccur:5,incontr:4,index:[],indic:8,indirizz:9,inerent:4,infin:10,info:4,inform:9,informat:0,initialization:1,inizial:3,inser:[4,9],insert_tim:1,install:[8,10],instanc:1,integr:[4,9,10],intellij:8,inter:9,interfacc:8,intern:[0,9,10],internet:9,interv:4,inutil:4,is_act:1,isadmin:1,isol:9,issu:4,issues:4,ital:4,its:1,json:[1,4,9],json_error:1,json_request_authorizer:1,json_success:1,jsx:0,jwt:[1,9],key:9,keys:1,kwargs:1,lasc:4,lavor:4,leg:4,librer:9,licenz:10,light:4,limit:[1,4],linux:[9,10],littl:1,local:[4,9],location:1,log:4,logg:4,login:[1,4],lookup:9,loopback:9,madeof:1,maggior:9,mak:8,makefil:10,manag:4,management:4,mancant:[3,5],manipol:0,manten:9,manual:[9,10],many:1,mapped:1,matc:1,max:9,mentr:10,messag:1,met:8,method:1,metod:[4,8],mett:[],miglior:4,missirol:5,mkdir:9,mockup:4,mod:[4,9],model:1,modic:4,modif:4,modul:[1,4,8],molt:[5,9],moment:4,mostr:0,mot:9,msg:1,mult:9,nam:1,names:1,necess:9,necessar:[9,10],needs:1,nest:9,nest_backend:[0,8,9],nest_crawler:[0,8],nest_frontend:[0,8],network:9,node_env:9,node_modules:9,node_version:9,nodejs:8,nom:[4,9],nonexisting:[],not:1,notification:1,notifications:[1,4],npm:9,nss:9,nuov:[4,8],nvm:9,oauth:4,onlin:9,only:1,oper:9,operation:1,operationtyp:1,ora:[1,4,9],org:9,organizz:4,orm:1,ospit:10,ottimizz:9,output:4,owner:[1,9],owner_id:1,owner_of:1,pacchett:9,pagin:4,pair:4,param:1,parametr:10,parents:9,parol:4,part:[0,4],particol:10,pass:4,password:1,payload:1,penpot:4,perc:[4,9],percors:[8,9],permett:10,personal:[],pertant:9,piccol:4,pien:9,plac:1,place_id:4,planning:4,platform:1,plugin:4,poetry:[9,10],poi:10,poker:4,port:9,poss:9,possibil:[9,10],post_tim:1,poster:1,postgres:9,postgresql:9,poter:4,powershell:8,precedent:9,predisposizion:4,preferibil:9,prem:9,prepar:4,prerequis:8,present:[0,1,4],prim:[4,9,10],principal:4,probabil:5,prod:9,prodott:3,production:9,prof:5,progett:[4,9,10],programming:4,project:4,propr:9,propriet:4,prosegu:9,prot:9,protocols:9,prov:4,proxy:8,proxypass:9,proxypassrevers:9,pubblic:[4,9],put:4,py3:9,pypoetry:9,pytest:4,python:[0,8,10],qual:[4,9],qualor:10,quant:[5,9],quel:4,quell:4,query:4,quest:[5,9,10],rappresent:9,react:[0,8],readthedocs:10,realizz:[0,4],recuper:0,recurs:9,refactor:4,refactoring:4,referenc:[],registered:1,registr:8,relat:[4,10],relationships:1,relazion:4,rend:9,rep:4,repositories:[1,4],repository:[1,4],repository_auth:1,repository_id:1,reqest:1,request_schem:9,requestheader:9,required:1,resocont:4,rest:9,restitu:4,restructuredtext:10,ret:9,retrieval:4,retrospect:4,retrospett:4,returned:1,returns:1,revers:8,review:4,rewriteengin:9,rewriterul:9,riavv:9,ricerc:4,ricev:8,richiest:4,ricord:9,rid:1,rig:9,riguard:4,rimang:9,rimozion:4,risolt:4,risolu:4,ritocc:4,ritorn:4,riusc:4,root:9,routes:8,rp_app:9,run:[9,10],ruol:9,salv:[0,9],sar:9,scanner:4,scaric:8,screenshots:8,script:[9,10],scritt:[0,4,10],scrittur:4,scrumbl:4,second:0,secret_key:9,security:9,see:9,segnal:4,segret:9,seguent:9,sembr:5,serializabl:1,serv:9,server:[0,1,9],servernam:9,servic:9,serviz:8,session:4,set:9,sets:1,setting:4,settings:4,setup:[4,9],shar:4,shell:[9,10],shouldnt:1,sicurezz:9,simpl:1,sint:9,sistem:[9,10],sit:4,snowflak:1,softw:0,sol:9,son:[5,9],sonarqub:4,sorgent:[8,10],sostitu:9,sourc:10,spec:1,specif:[1,4],specific:4,sphinx:10,sprint1:4,sprint2:4,sprint:[5,8],sqlalchemy:[1,9],sqlalchemy_database_ur:9,srs:4,srv:9,sslcertificatefil:9,sslcertificatekeyfil:9,sslengin:9,standard:10,standardizz:4,start:[1,9],stat:[4,5,9],statist:[0,8],steff:9,stess:9,stesur:4,stories:4,strict:9,string:[1,9],strument:[8,10],struttur:[4,10],stud:4,success:9,successful:1,such:1,suddivision:8,sugger:9,support:4,svilupp:4,svolt:4,swagger:4,system:1,systemctl:9,systemd:8,tabell:8,tables:8,taig:4,talvolt:9,target:[9,10],tast:9,tastier:9,team:4,tecnic:4,ten:5,tentat:4,termin:4,test:[4,9],testing:4,tests:4,that:1,the:[1,9],thes:1,thing:1,thingamajigs:1,tim:1,tip:4,titl:[],titol:[],to_json:1,toctre:[],toggl:[],token:9,too:[],total:4,traduzion:4,tram:[4,9],transport:9,tre:0,trov:10,tutt:[4,9],tweepy:0,tweet:[0,1,4],tweets:1,twitter:[0,4],type:[1,9],ugual:[],ulterior:4,ultim:[4,10],underlin:[],unimor:0,unit:9,usa:9,usand:0,use:4,used:1,user:[1,4,9,10],useradd:9,usernam:1,users:4,using:1,uso:9,usr:9,utent:[0,4],utility:8,utilizz:[4,8,9],valid:1,valu:1,values:1,valut:4,variabil:9,ved:[1,9],ven:4,vendored:5,veng:9,venv:[9,10],verif:9,verification:1,verr:9,version:[4,9,10],vide:4,vim:9,virtual:10,virtualenv:9,virtualenvs:9,virtualhost:9,visualizz:0,volt:[4,10],want:1,wantedby:9,wants:9,was:1,web:[0,8,9],whether:1,window_siz:1,windows:8,working:9,workingdirectory:9,you:[1,9]},titles:["Il progetto","nest_backend- Web API in Python","nest_crawler- Crawler in Python","Feedback ricevuto dal cliente","Registro attivit\u00e0","Statistiche di Gitinspector","Strumenti utilizzati","nest_frontend- Interfaccia utente in React","N.E.S.T.","Installazione","Meta-documentazione"],titleterms:{analyst:4,anniball:4,apac:9,api:1,attiv:4,autogener:8,backend:[4,9],balugan:4,bas:1,calzolar:4,chiar:4,client:3,cocc:4,codic:9,colleg:8,collett:4,com:9,compend:8,compil:[9,10],configur:9,consegn:3,crawler:[2,9],cre:9,databas:[1,9],designer:4,developer:4,dipendent:9,document:[3,8,10],estension:1,far:[3,4,5,9],feedback:3,fil:9,flask:1,flav:4,forn:[],frontend:[4,9],gestion:1,giorg:4,giovann:4,gitinspector:5,gnu:10,goldon:4,guid:8,ide:10,individual:4,inform:[],install:9,intellij:10,interfacc:7,lorenz:4,mak:10,manual:8,master:4,met:10,metod:1,minoccar:4,modul:0,nest_backend:1,nest_crawler:2,nest_frontend:7,nodejs:9,nuov:9,owner:4,percors:1,pigozz:4,powershell:10,prerequis:9,product:4,progett:[0,8],proxy:9,python:[1,2,9],react:7,registr:4,revers:9,ricev:3,riunion:4,routes:1,scaric:9,screenshots:0,scrum:4,serviz:9,sorgent:9,sprint:[3,4],statist:5,stef:4,strument:6,suddivision:0,svilupp:8,sysadmin:4,systemd:9,tabell:1,tables:1,tester:4,utent:[7,8,9],util:8,utility:1,utilizz:6,web:1,windows:10}}) \ No newline at end of file diff --git a/docs/source/about/frontendAlertCreate.png b/docs/source/about/frontendAlertCreate.png new file mode 100644 index 0000000..94e0e18 Binary files /dev/null and b/docs/source/about/frontendAlertCreate.png differ diff --git a/docs/source/about/frontendAnalysis.png b/docs/source/about/frontendAnalysis.png new file mode 100644 index 0000000..b8de2ae Binary files /dev/null and b/docs/source/about/frontendAnalysis.png differ diff --git a/docs/source/about/frontendDashboard.png b/docs/source/about/frontendDashboard.png new file mode 100644 index 0000000..969ff3a Binary files /dev/null and b/docs/source/about/frontendDashboard.png differ diff --git a/docs/source/about/frontendRepositoryCreate.png b/docs/source/about/frontendRepositoryCreate.png new file mode 100644 index 0000000..2ae3c39 Binary files /dev/null and b/docs/source/about/frontendRepositoryCreate.png differ diff --git a/docs/source/about/frontendRepositoryShare.png b/docs/source/about/frontendRepositoryShare.png new file mode 100644 index 0000000..14ed9c0 Binary files /dev/null and b/docs/source/about/frontendRepositoryShare.png differ diff --git a/docs/source/about/index.rst b/docs/source/about/index.rst index 292ff5c..862e0a5 100644 --- a/docs/source/about/index.rst +++ b/docs/source/about/index.rst @@ -1,2 +1,42 @@ Il progetto =========== + +**N.E.S.T.** (Noi Estraiamo Statistiche Tweet) è un progetto realizzato nel 2021 per +l'**esame di Progetto del Software** del corso di Informatica all'Unimore. + + +Suddivisione in moduli +---------------------- + +Il progetto è composto da tre parti: + +:py:mod:`nest_crawler` + Un modulo scritto in `Python`_ usando :py:mod:`tweepy` che recupera tweet attraverso la `Twitter API`_ secondo le + condizioni presenti all'interno del database e li salva per future elaborazioni. + +:py:mod:`nest_backend` + Un web server scritto in `Python`_ usando il framework :py:mod:`flask` che fornisce un'API HTTP per visualizzare e + manipolare i dati dell'applicazione, gestendo autenticazione, autorizzazione e comunicazione con il database. + +:js:mod:`nest_frontend` + Una applicazione web scritta in `JSX`_ usando il framework :js:mod:`react` che comunica con il backend, mostrando + all'utente i dati del backend in una formato immediatamente comprensibile. + + +.. _Python: https://www.python.org/ +.. _Twitter API: https://developer.twitter.com/en/docs/twitter-api +.. _JSX: https://reactjs.org/docs/introducing-jsx.html + + +Screenshots +----------- + +.. image:: frontendDashboard.png + +.. image:: frontendRepositoryCreate.png + +.. image:: frontendAnalysis.png + +.. image:: frontendRepositoryShare.png + +.. image:: frontendAlertCreate.png