Merge pull request #67 from Demea9000/test-documentation-oresti

Makefile

@@ -0,0 +1,5 @@
+pipeline:
+	python app.py
+
+setup:
+	pip install -r requirements.txt

app.py

@@ -0,0 +1,17 @@
+from textclassifier import TextClassifier as tc
+
+
+def main():
+    """
+    Main function. Runs the program.
+    :return: None
+    """
+    from_date = input("Enter from date (YYYY-MM-DD): ")
+    to_date = input("Enter to date (YYYY-MM-DD): ")
+    user_name = input("Enter user name: ")
+    text_classifier = tc.TextClassifier(from_date=from_date, to_date=to_date, user_name=user_name, num_tweets=20)
+    text_classifier.run_main_pipeline()
+
+
+if __name__ == "__main__":
+    main()

data/twitterdata.csv

@@ -49,3 +49,23 @@ id,tweet,date,user_id,username,urls,nlikes,nreplies,nretweets,topic,sentiment,ta
 1239960121544933383,"Vi har alla ett ansvar. Oavsett vilka vi är, var vi bor eller hur vi drabbas, så är vi alla en del av Sverige. Låt oss alla hedra det i dessa svåra tider.",2020-03-17 18:01:44,95972673,jimmieakesson,[],196,6,12, 1. swedish society 2. coronavirus pandemic 3. solidarity,statements,The people of Sweden.
 1239960095993331712,"Vissa drabbas hårdare än andra, men det är bara genom gemensamma ansträngningar vi kan utmana och övervinna krisen.",2020-03-17 18:01:38,95972673,jimmieakesson,[],110,1,7, covid-19 sub topic 1: effects sub topic 2: solutions,statements,The people of Sweden.
 1239960079929090048,"Det kan inte nog betonas att vi befinner oss i ett riktigt allvarligt läge. Belastningen på samhället är redan hård, och allt tyder på att vi har en lång och svår period framför oss.",2020-03-17 18:01:35,95972673,jimmieakesson,[],154,3,10, 1. covid-19 2. sweden 3. lockdown,concern,The Swedish government.
+1253274192734236679,"SD går nu vidare med ett förslag i finansutskottet, vilket flera partier tillstått är den rätta vägen framåt. SD:s initiativ innebär alltså att M, KD, C och L nu måste bekänna färg – vill de tvinga regeringen att ta fram förslag om direkt stöd eller inte?   https://t.co/MYCu5guWDj",2020-04-23 12:47:06,95972673,jimmieakesson,['https://www.di.se/nyheter/sd-synar-m-utspelet-vill-tvinga-fram-direktstod-genom-riksdagen/'],394,19,76, 1. swedish politics 2. the budget 3. government support,agreement,N/A
+1253015508565266432,"Det riskerar att upplevas som svagt ledarskap i en tid då just ledarskap och handlingskraft är viktigare än någonsin.   Ulf, @BuschEbba, Nyamko och Anders: Vad väntar ni på?",2020-04-22 19:39:11,95972673,jimmieakesson,[],134,6,10, 1. swedish politics 2. the leadership of the swedish moderate party 3. the leadership of the swedish centre party,criticism,"Ulf, @BuschEbba, Nyamko och Anders"
+1253015184471359493,Vi föreslår att regeringen skyndsamt ska återkomma till riksdagen med förslag om en ersättningsmodell för direktstöd i enlighet med beskrivningen ovan.   För mig är det obegripligt att de partier som säger sig vilja ge direktstöd ändå väljer att inte stötta detta förslag.,2020-04-22 19:37:54,95972673,jimmieakesson,[],134,3,12, 1. swedish politics 2. government 3. direct aid,criticism,Regeringen
+1253015126640340995,Men besluten fördröjs av att övriga oppositionspartier inte vill sätta ner foten.   Till imorgon torsdag har vi lagt ett förslag på Näringsutskottets bord.,2020-04-22 19:37:40,95972673,jimmieakesson,[],60,1,5, 1. swedish politics 2. the opposition 3. legislation,statements,N/A
+1253014871190487040,Vad väntar ni på?   Den 24 mars krävde jag att regeringen skulle se över möjligheten att ge kontanta direktstöd till företag som tappat en betydande del av sin omsättning. Nu en månad senare tycks det finnas en majoritet i riksdagen för sådant direktstöd.  https://t.co/gOYvr6qMaI,2020-04-22 19:36:39,95972673,jimmieakesson,[],561,22,83, 1. swedish politics 2. financial relief for businesses 3. coronavirus pandemic,admiration,The Swedish government
+1252831133198254081,Ardalan Shekarabi: Vad har du att säga till alla de som trodde på ditt löfte? Till alla de som nu träffas av en verklighet som inte alls överensstämmer med den bild som målades upp?   https://t.co/KWeWA08trF,2020-04-22 07:26:33,95972673,jimmieakesson,['https://www.expressen.se/debatt/shekarabi-sviker-tusentals-i-regeringens-jatteblasning/'],605,48,102, 1. swedish politics 2. the moderate party 3. promises not kept,criticism,Ardalan Shekarabi
+1252553996822294528,Igår riktade jag dessa frågor till socialförsäkringsminister @shekarabi och jag förväntar mig att han kryper fram och tar ansvar för den här bluffen.,2020-04-21 13:05:18,95972673,jimmieakesson,[],188,8,20, 1. swedish politics 2. social security 3. minister @shekarabi,criticism,Shekarabi
+1252553954086576129,"Jag frågade också hur det kunde bli så här, vem har bestämt regelverket. Det visste inte statsministern, men han framhöll att regeringen är högst ansvarig.",2020-04-21 13:05:08,95972673,jimmieakesson,[],149,6,7, 1. government 2. legislation 3. sweden,criticism,Regeringen
+1252553912957141002,"Alternativet vore att göra det som utlovades, nämligen ""slopa karensavdraget"" det vill säga full sjuklön från dag 1.  Eller helt enkelt vara ärliga från början.",2020-04-21 13:04:58,95972673,jimmieakesson,[],201,8,19, 1. swedish politics 2. the alternative party 3. taxation,opinion,The Swedish government
+1252553744656543746,"Idag frågade jag statsminister Stefan Löfven om hur det kunde bli som det blev med slopandet av karensavdraget. Svaret blev att ""alternativet hade varit noll"". Nej, Stefan Löfven, alternativet vore inte noll.  https://t.co/4fy92DFxgM",2020-04-21 13:04:18,95972673,jimmieakesson,[],770,41,146, 1. swedish politics 2. prime minister stefan löfven 3. tax policy,criticism,Stefan Löfven
+1252151278098096129,@shekarabi varför vilseleder du folk?  https://t.co/7GPcwRmdrc,2020-04-20 10:25:03,95972673,jimmieakesson,[],23,2,5, 1. social media 2. twitter 3. misinformation,criticism,Shekarabi
+1252135884369072128,Regeringen har vilselett Sverige och framställt sitt förslag bättre än va det visade sig vara. Det är skamligt och regeringen måste ta sitt ansvar och omgående leva upp till sina löften. Hela karensavdraget bör tillfälligt avskaffas!,2020-04-20 09:23:53,95972673,jimmieakesson,[],487,12,47, 1. swedish government 2. politics 3. economics,criticism,Regeringen
+1252135857479393282,"Med en begränsad schablonersättning på 700kr, drabbas fortfarande många löntagare av betydande inkomstbortfall när de tar sitt ansvar och stannar hemma med symptom.",2020-04-20 09:23:46,95972673,jimmieakesson,[],345,4,33, 1. swedish labor laws 2. income inequality 3. public health,criticism,löntagare
+1252135818560516096,Regeringen lovade att slopa karensavdraget för att under Coronakrisen ge löntagare bättre förutsättningar att stanna hemma vid minsta symptom. Det välkomnade både vi och många andra.  Utfallet har nu visat att verkligheten blev något annat.,2020-04-20 09:23:37,95972673,jimmieakesson,[],888,50,151, 1. swedish government 2. promises during coronavirus 3. outcome of promises,criticism,Regeringen
+1251115953892589569,"Lite märkligt att Kommunal kräver skyddsutrustning först nu, men oavsett visar detta — fullt rimliga — besked att vi måste ta personalens krav och oro på största allvar. Annars kommer det inte gå att bedriva äldreomsorg alls.  Nu måste regeringen sätta ner foten!  https://t.co/jiWveep68E",2020-04-17 13:51:02,95972673,jimmieakesson,[],339,43,63, 1. swedish politics 2. elderly care 3. personal protective equipment,opinion,The Swedish government.
+1251109502163865600,"Det handlar om att rädda liv. Alla som kämpar mot pandemin, inom vård och omsorg, ska ha tillgång till den skyddsutrustning de behöver.   Att dessa krav fortfarande inte tillgodosetts är inget annat än en praktskandal!",2020-04-17 13:25:24,95972673,jimmieakesson,[],258,14,34, 1. healthcare 2. covid-19 3. ppe,criticism,The Swedish government.
+1251109479770398722,"Sedan Coronakrisens inledning har jag haft kontakt med otroligt många oroliga kvinnor och män som jobbar inom vård, hemtjänst och övrig omsorg. De vill ha skyddsutrustning, både för sin egen och vård- och omsorgstagarnas hälsa och trygghet.  https://t.co/SO8aUXUPuj",2020-04-17 13:25:19,95972673,jimmieakesson,[],488,26,73, 1. swedish healthcare workers during the coronavirus pandemic 2. personal protective equipment 3. patient care,concern,healthcare workers
+1251074785091686401,Detta är så ansvarslöst och så verklighetsfrånvänt.  Att denna förtäckta amnesti överhuvudtaget kom till var en stor skandal. Att ge uppehållstillstånd till företrädesvis vuxna män utan skyddsbehov är riktigt usel politik och måste stoppas.  https://t.co/UjzGU2JTGN,2020-04-17 11:07:27,95972673,jimmieakesson,[],2230,108,325, 1. immigration 2. amnesty 3. sweden,criticism,Regeringen
+1250390920807276544,En möjlighet till permittering på 100 procent kopplat till fullt statligt kostnadsansvar är det enda som gäller nu. Inget annat duger.   https://t.co/cTZKfxiJQX,2020-04-15 13:50:01,95972673,jimmieakesson,['https://www.aftonbladet.se/debatt/a/70OwyB/lat-foretag-permittera-upp-till-100-procent'],309,31,52, 1. swedish politics 2. coronavirus 3. unemployment,statements,The Swedish government.
+1250027643753373696,"Alla företag ska omfattas på lika villkor, men vi har förståelse för att det behöver finnas kontrollmekanismer när det gäller företag utan kollektivavtal.",2020-04-14 13:46:29,95972673,jimmieakesson,[],108,2,16, 1. swedish labor laws 2. enforcement of labor laws 3. exceptions to labor laws,statements,All companies

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'politweet'
+copyright = '2022, Oresti Theodoridis, Marcus Ascard, Mosa Hosseini, Nils Ekstrand'
+author = 'Oresti Theodoridis, Marcus Ascard, Mosa Hosseini, Nils Ekstrand'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. politweet documentation master file, created by
+   sphinx-quickstart on Mon Jul 18 11:41:38 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to politweet's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`