45 |
106 |
118 |
122 |
131 |
132 |
133 |
--------------------------------------------------------------------------------
/docs (help)/_build/html/genindex.html:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
46 |
60 |
104 |
105 |
47 |
59 |
48 |
49 |
58 |
50 |
55 |
56 |
57 | Donations¶
51 |Considerable effort has gone into writing this software which I’m releasing under the terms of the GNU General Public License.
52 |If you find this software useful, don’t hesitate to make a financial contribution by clicking on the Donate button below.
53 |If you would like additional features, I’m a freelance developer and I can bill internationally.
54 |
42 |
93 |
102 |
106 |
115 |
116 |
--------------------------------------------------------------------------------
/docs (help)/_build/html/objects.inv:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/_build/html/objects.inv
--------------------------------------------------------------------------------
/docs (help)/_build/html/search.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
43 |
57 |
91 |
92 |
44 |
56 |
45 |
46 |
47 |
55 | Index
48 | 49 |
50 |
51 |
52 |
53 |
54 |
49 |
103 |
112 |
116 |
125 |
126 |
--------------------------------------------------------------------------------
/docs (help)/_build/html/searchindex.js:
--------------------------------------------------------------------------------
1 | Search.setIndex({envversion:47,filenames:["blog","donate","external","fields","find","generate","index","properties","save","why"],objects:{},objnames:{},objtypes:{},terms:{"class":9,"new":2,"public":1,"while":9,about:0,accountableperson:7,activ:9,add:[5,7],addit:[1,2],adjust:4,aim:9,all:[5,8,9],allow:9,alphacod:9,also:0,amp:9,app:9,appear:0,applic:[0,1,2,3,4,5,6,7,8,9],assum:6,back:[5,8],below:1,bill:1,block:9,blog:0,bodi:9,bot:[0,1,2,3,4,5,6,7,8,9],browser:8,button:[0,1,3],can:[0,1,5,6,7,8,9],cfm:9,chang:9,choos:4,chosen:0,clear:6,click:[0,1,7,8],client:4,collabor:9,common:9,commonspot:9,commun:9,consider:1,continu:8,contribut:1,control:[0,1,2,3,4,5,6,7,8,9],copi:5,could:9,creat:9,customcf:9,data:[0,1,2,3,4,5,6,7],delet:8,depend:9,develop:1,differ:[0,9],div:9,don:1,done:5,easili:5,effort:1,engin:[3,7,9],error:5,even:9,exampl:[0,6],exist:9,extern:0,familiar:6,featur:1,field:[3,5,7,8],financi:1,find:1,first:[0,9],follow:9,freelanc:1,from:9,further:0,gener:[0,1,2,3,4],geo:9,geocoordin:9,gnu:1,gone:1,good:5,gov:9,hasmap:9,have:[0,5],here:5,hesit:1,hidden:9,hide:9,highlight:5,href:9,htm:9,html:[0,1,2,3,4,5,6,7,8,9],http:9,icon:2,ifram:9,imag:0,improv:9,index:[6,9],info:3,inform:[0,2,7,8,9],instanc:[0,9],integr:9,internation:1,internet:9,itemprop:9,itemscop:9,itemtyp:9,javascript:[0,1,2,3,4,5,6,7,8,9],just:3,keyword:9,know:5,later:[0,7],latitud:9,lead:[0,2],let:9,level:4,licens:1,like:1,link:0,localbusi:9,localstorag:[3,6],longitud:9,look:9,maintain:9,make:1,mandatori:5,map:9,mark:2,markup:[5,9],meaning:9,mission:9,model:[0,1,2,3,4,5,6,7,8,9],modul:6,moment:5,more:[0,7,8],most:[4,7],multipl:9,name:9,navig:5,nbsp:5,need:[4,7,8,9],next:4,now:[0,3,5,7],observ:0,obtain:9,offercatalog:9,onc:5,open:2,option:7,org:[0,1,2,3,4,5,6,7,8,9],other:9,output:6,own:5,page:[0,6,9],park:9,parknam:9,past:5,person:7,possibl:[3,9],postaladdress:7,product:9,promot:9,properti:0,provid:9,quick:9,quot:9,reader:6,readm:6,recov:6,releas:1,right:8,save:[0,3,6],search:[3,6,7,9],see:[0,7],sell:9,seo:9,server:[0,1,2,3,4,5,6,7,8,9],share:7,show:[0,3,6],showmap:9,shown:5,simultan:9,site:9,softwar:[1,6],some:[5,9],span:9,src:9,start:[5,7],still:9,store:8,structur:[0,1,2,3,4,5,6,7,8,9],tab:[0,2],take:8,term:1,test:[0,1,2,3,4,5,6,7,8,9],text:7,thi:[0,1,2,5,6,8],thing:0,three:9,tool:[0,1,2,3,4,5],top:4,transform:9,trial:5,two:9,txt:6,type:3,under:1,url:9,user:[8,9],view:[0,1,2,3,4,5,6,7,8,9],visit:4,wai:[5,8],want:[3,7],web:[0,1,2,3,4,5,6,7,8,9],websit:[2,4,5,9],which:[1,4,5],why:6,without:0,work:8,would:[1,6],write:1,www:9,yell:9,yellowston:9,you:[1,3,5,6],your:[4,5,9]},titles:["Pick a schema","Donations","External links","Fill out the properties","Find a Schema","Generate Schema Button","Welcome to the Schema Generator help!","Show properties","Save Schema to LocalStorage","Why would you use this software?"],titleterms:{button:[5,8],clear:8,data:8,donat:1,exampl:9,extern:2,fill:3,find:4,gener:[5,6],help:6,indic:6,link:2,localstorag:8,out:3,output:9,pick:0,properti:[3,7],recov:8,save:8,schema:[0,4,5,6,8],show:7,softwar:9,tabl:6,thi:9,tool:6,valid:5,welcom:6,where:6,why:9,would:9,you:9}})
--------------------------------------------------------------------------------
/docs (help)/_templates/localtoc.html:
--------------------------------------------------------------------------------
1 | {#
2 | basic/localtoc.html
3 | ~~~~~~~~~~~~~~~~~~~
4 |
5 | Sphinx sidebar template: local table of contents.
6 |
7 | :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
8 | :license: BSD, see LICENSE for details.
9 | #}
10 | {%- if display_toc %}
11 |
50 |
80 |
101 |
102 |
51 |
79 |
52 |
53 |
78 | Search
54 |
55 |
56 |
61 | 57 | Please activate JavaScript to enable the search 58 | functionality. 59 |
60 |62 | From here you can search these documents. Enter your search 63 | words into the box below and click "search". Note that the search 64 | function will automatically search for all of the words. Pages 65 | containing fewer words won't appear in the result list. 66 |
67 | 72 | 73 |
74 |
75 |
76 |
77 | {{ _('Page Contents') }}
12 | {{ toc }} 13 | {%- endif %} 14 | -------------------------------------------------------------------------------- /docs (help)/blog.rst: -------------------------------------------------------------------------------- 1 | Pick a schema 2 | ============= 3 | 4 | We'll pick ``Blog`` as an example 5 | 6 | .. raw:: html 7 | 8 |
9 |
10 | Having chosen a schema, we can now see the properties of the schema. We can also observe the ``Save Schema`` and ``Generate Schema`` buttons appearing. More on these later.
11 |
12 | .. raw:: html
13 |
14 | 
15 |
16 | Links with the |external_link| image will lead to a |schema.org| |external_link| page in a different tab for further information. :doc:`external`
17 |
18 | Links without this |external_link| image will show the properties of that schema. For instance the first property of ``Blog`` is ``about``. ``about`` is a ``Thing``. Clicking on ``Thing`` will show the properties of ``Thing``.
19 |
20 | :doc:`properties`
21 |
22 |
--------------------------------------------------------------------------------
/docs (help)/donate.rst:
--------------------------------------------------------------------------------
1 | Donations
2 | =========
3 |
4 | Considerable effort has gone into writing this software which I'm releasing under the terms of the GNU General Public License.
5 |
6 | If you find this software useful, don't hesitate to make a financial contribution by clicking on the **Donate** button below.
7 |
8 | If you would like additional features, I'm a freelance developer and I can bill internationally.
9 |
--------------------------------------------------------------------------------
/docs (help)/external.rst:
--------------------------------------------------------------------------------
1 | External links
2 | ==============
3 |
4 | Links marked with the |external_link| icon will lead to the |schema.org| |external_link| website.
5 |
6 | .. raw:: html
7 |
8 | 
9 |
10 | This will open a new tab with additional information.
11 |
12 | .. raw:: html
13 |
14 | 
15 |
--------------------------------------------------------------------------------
/docs (help)/extra/Readme.txt:
--------------------------------------------------------------------------------
1 | Tool for generating a valid Scheme as proposed by Schema.org
2 | Copyright (C) 2016 - 2021 Hans Polak
3 |
4 | This program is free software: you can redistribute it and/or modify
5 | it under the terms of the GNU General Public License as published by
6 | the Free Software Foundation, either version 3 of the License, or
7 | (at your option) any later version.
8 |
9 | This program is distributed in the hope that it will be useful,
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | GNU General Public License for more details.
13 |
14 | You should have received a copy of the GNU General Public License
15 | along with this program. If not, see 
9 |
10 | Now, it's possible to :doc:`save` or :doc:`generate`
11 |
--------------------------------------------------------------------------------
/docs (help)/find.rst:
--------------------------------------------------------------------------------
1 | Find a Schema
2 | =============
3 |
4 | Visit the |generator_tool| |external_link| website and choose the top level schema which is most adjusted to your (client's) needs. Next, we'll need to :doc:`blog`
5 |
6 | .. raw:: html
7 |
8 | 
9 |
10 | .. |generator_tool| raw:: html
11 |
12 | Generator Tool
13 |
--------------------------------------------------------------------------------
/docs (help)/generate.rst:
--------------------------------------------------------------------------------
1 | Generate Schema Button
2 | ======================
3 |
4 | Once you have generated your schema's markup, you can then go and test it.
5 |
6 | .. raw:: html
7 |
8 | 
9 |
10 | Test at |Structured Data Testing Tool| |external_link|
11 |
12 | .. raw:: html
13 |
14 | 
15 | 16 | 17 | Validate the Schema 18 | =================== 19 | 20 | You can easily test your schema by copying it and paste it in the |Structured Data Testing Tool| |external_link| 21 | 22 | .. raw:: html 23 | 24 |
25 | 26 | .. raw:: html 27 | 28 |
29 | 30 | .. raw:: html 31 | 32 |
33 |
34 | |All good|? Done!
35 |
36 | .. |All good| raw:: html
37 |
38 |
42 | All good 
43 |
44 | Now, you can start to add this markup to your own websites as |shown here|
45 |
46 | .. |shown here| raw:: html
47 |
48 | shown here
49 |
50 | Some schema's have mandatory fields. The |Structured Data Testing Tool| |external_link| will highlight these. You can add these fields by using the ``back`` button of the navigator you're using. At this moment, this tool has no way of knowing which fields are mandatory. It's trial and error.
51 |
--------------------------------------------------------------------------------
/docs (help)/images/D1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D1.png
--------------------------------------------------------------------------------
/docs (help)/images/D10.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D10.png
--------------------------------------------------------------------------------
/docs (help)/images/D11.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D11.png
--------------------------------------------------------------------------------
/docs (help)/images/D12.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D12.png
--------------------------------------------------------------------------------
/docs (help)/images/D13.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D13.png
--------------------------------------------------------------------------------
/docs (help)/images/D14.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D14.png
--------------------------------------------------------------------------------
/docs (help)/images/D15.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D15.png
--------------------------------------------------------------------------------
/docs (help)/images/D16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D16.png
--------------------------------------------------------------------------------
/docs (help)/images/D17.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D17.png
--------------------------------------------------------------------------------
/docs (help)/images/D2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D2.png
--------------------------------------------------------------------------------
/docs (help)/images/D3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D3.png
--------------------------------------------------------------------------------
/docs (help)/images/D4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D4.png
--------------------------------------------------------------------------------
/docs (help)/images/D5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D5.png
--------------------------------------------------------------------------------
/docs (help)/images/D6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D6.png
--------------------------------------------------------------------------------
/docs (help)/images/D7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D7.png
--------------------------------------------------------------------------------
/docs (help)/images/D8.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D8.png
--------------------------------------------------------------------------------
/docs (help)/images/D9.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/D9.png
--------------------------------------------------------------------------------
/docs (help)/images/external_link.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/external_link.png
--------------------------------------------------------------------------------
/docs (help)/images/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (help)/images/favicon.ico
--------------------------------------------------------------------------------
/docs (help)/index.rst:
--------------------------------------------------------------------------------
1 | .. Schema documentation master file, created by
2 | sphinx-quickstart on Sat Feb 13 13:27:50 2016.
3 | You can adapt this file completely to your liking, but it should at least
4 | contain the root `toctree` directive.
5 |
6 | Welcome to the `Schema Generator` help!
7 | =======================================
8 |
9 | I'm assuming the reader is familiar with |html| |external_link|
10 |
11 | .. toctree::
12 | :maxdepth: 3
13 |
14 | why
15 | find
16 | blog
17 | properties
18 | fields
19 | save
20 | generate
21 | external
22 | donate
23 |
24 | Where is the tool?
25 | ==================
26 |
27 | You can use the |Schema Generator| |external_link|
28 |
29 | Indices and tables
30 | ==================
31 |
32 | * :ref:`genindex`
33 | * :ref:`modindex`
34 | * :ref:`search`
35 |
36 | .. |Readme.txt| raw:: html
37 |
38 | Readme.txt
39 |
40 |
--------------------------------------------------------------------------------
/docs (help)/properties.rst:
--------------------------------------------------------------------------------
1 | Show properties
2 | ===============
3 |
4 | ``accountablePerson`` is a ``Person``
5 |
6 | .. raw:: html
7 |
8 | 
9 |
10 | By clicking on ``Person``, we can now see the properties of the schema.
11 |
12 | .. raw:: html
13 |
14 | 
15 |
16 | We can add more information as needed. ``Person`` has a ``PostalAddress``
17 |
18 | .. raw:: html
19 |
20 | 
21 |
22 | .. raw:: html
23 |
24 | 
25 |
26 | Now, we can start to fill out the text fields with the information we **want** to share with the Search Engines. Most fields are optional, but we'll see that later.
27 |
28 | :doc:`fields`
29 |
--------------------------------------------------------------------------------
/docs (help)/save.rst:
--------------------------------------------------------------------------------
1 | Save Schema to LocalStorage
2 | ===========================
3 |
4 | Schema Generator can store the data in the browser. This way, the user can continue to work on the schema, adding more fields as needed.
5 |
6 | .. raw:: html
7 |
8 | 
9 |
10 |
11 | Recover Data button
12 | ===================
13 |
14 | Clicking the ``Recover Data`` button will take us right back to :doc:`fields`
15 |
16 | Clear Data button
17 | =================
18 |
19 | Clicking the ``Clear Data`` button will delete all information saved in LocalStorage.
20 |
--------------------------------------------------------------------------------
/docs (help)/why.rst:
--------------------------------------------------------------------------------
1 | Why would you use this software?
2 | ================================
3 |
4 | "|Schema.org| |external_link| *is a collaborative, community activity with a mission to create, maintain, and promote schema's for structured data on the Internet*" This '*structured data*' helps Search Engines to obtain meaningful information from your website, even if this is ``hidden`` from the user of the website. This can improve the SEO of the websites you maintain.
5 |
6 | Depending on your needs, you could use other, existing, tools for adding |Schema.org| |external_link| schemas to your website. *This tool* aims to provide valid |HTML| |external_link| markup that can be used to integrate these schema's into your website.
7 |
8 | Example output
9 | ==============
10 |
11 | Let's look at a quick example. The first HTML block is generated with this tool, the following two blocks are possible transformations.
12 |
13 | For instance
14 |
15 | .. raw:: html
16 |
17 | <div itemscope itemtype="http://schema.org/Park">
18 | <div itemprop=geo itemscope itemtype="http://schema.org/GeoCoordinates">
19 | <span itemprop="latitude">44.4279668</span>
20 | <span itemprop="longitude">-110.5906437</span>
21 | </div>
22 | <span itemprop="hasMap">http://www.nps.gov/common/commonspot/customcf/apps/maps/showmap.cfm?alphacode=yell&parkname=Yellowstone</span>
23 | <span itemprop="name">Yellowstone</span>
24 | <span itemprop="url">http://www.nps.gov/yell/index.htm</span>
25 | </div>
26 | Yellowstone
35 |
36 | Latitude: 44.4279668
37 | Longitude: -110.5906437
38 |
39 | 37 | Longitude: -110.5906437
38 |
40 |
41 |
42 | Go to site
43 |
44 |
45 | The ``hidden`` keyword can be used to hide some information from the markup, while still allowing Search Engines to find this information.
46 |
47 | .. code-block:: html
48 |
49 |
50 | Yellowstone
51 |
52 | Latitude: 44.4279668
53 | Longitude: -110.5906437
54 |
55 | 53 | Longitude: -110.5906437
54 |
56 |
57 |
58 | Go to site
59 |
60 |
61 | All three HTML blocks can be validated with the |Structured Data Testing Tool| |external_link|.
62 |
63 | Multiple schemas can be used simultaneously on one page. For instance, a |LocalBusiness| |external_link| can sell different products (|OfferCatalog| |external_link|).
64 |
65 | .. |LocalBusiness| raw:: html
66 |
67 | LocalBusiness
68 |
69 | .. |OfferCatalog| raw:: html
70 |
71 | OfferCatalog
72 |
--------------------------------------------------------------------------------
/docs (technical)/_build/doctrees/apache.doctree:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (technical)/_build/doctrees/apache.doctree
--------------------------------------------------------------------------------
/docs (technical)/_build/doctrees/controller.doctree:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (technical)/_build/doctrees/controller.doctree
--------------------------------------------------------------------------------
/docs (technical)/_build/doctrees/environment.pickle:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (technical)/_build/doctrees/environment.pickle
--------------------------------------------------------------------------------
/docs (technical)/_build/doctrees/index.doctree:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (technical)/_build/doctrees/index.doctree
--------------------------------------------------------------------------------
/docs (technical)/_build/doctrees/javascript.doctree:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (technical)/_build/doctrees/javascript.doctree
--------------------------------------------------------------------------------
/docs (technical)/_build/doctrees/model.doctree:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (technical)/_build/doctrees/model.doctree
--------------------------------------------------------------------------------
/docs (technical)/_build/doctrees/schema_bot.doctree:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (technical)/_build/doctrees/schema_bot.doctree
--------------------------------------------------------------------------------
/docs (technical)/_build/doctrees/view.doctree:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/docs (technical)/_build/doctrees/view.doctree
--------------------------------------------------------------------------------
/docs (technical)/_build/html/.buildinfo:
--------------------------------------------------------------------------------
1 | # Sphinx build info version 1
2 | # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3 | config: 9b33ad886b9c2d9df2c1a0baaaa9a9a5
4 | tags: 645f666f9bcd5a90fca523b33c5a78b7
5 |
--------------------------------------------------------------------------------
/docs (technical)/_build/html/Readme.txt:
--------------------------------------------------------------------------------
1 | Tool for generating a valid Scheme as proposed by Schema.org
2 | Copyright (C) 2016 - 2021 Hans Polak
3 |
4 | This program is free software: you can redistribute it and/or modify
5 | it under the terms of the GNU General Public License as published by
6 | the Free Software Foundation, either version 3 of the License, or
7 | (at your option) any later version.
8 |
9 | This program is distributed in the hope that it will be useful,
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | GNU General Public License for more details.
13 |
14 | You should have received a copy of the GNU General Public License
15 | along with this program. If not, see <div itemscope itemtype="http://schema.org/Park">
28 | <div itemprop=geo itemscope itemtype="http://schema.org/GeoCoordinates">
29 | <span itemprop="latitude">44.4279668</span>
30 | <span itemprop="longitude">-110.5906437</span>
31 | </div>
32 | <span itemprop="hasMap">http://www.nps.gov/common/commonspot/customcf/apps/maps/showmap.cfm?alphacode=yell&parkname=Yellowstone</span>
33 | <span itemprop="name">Yellowstone</span>
34 | <span itemprop="url">http://www.nps.gov/yell/index.htm</span>
35 | </div>
36 |
52 |
106 |
118 |
122 |
123 |
124 |
--------------------------------------------------------------------------------
/docs (technical)/_build/html/searchindex.js:
--------------------------------------------------------------------------------
1 | Search.setIndex({objnames:{"0":["py","module","Python module"],"1":["py","staticmethod","Python static method"],"2":["py","method","Python method"],"3":["py","class","Python class"],"4":["py","attribute","Python attribute"]},filenames:["apache","schema_bot","controller","javascript","index","model","view"],titleterms:{javascript:3,start:[1,2],server:[1,2],port:2,welcom:4,bot:1,restart:[1,2],anoth:2,copyright:4,"default":2,apache2:0,down:2,control:2,indic:4,inform:4,tabl:4,document:4,schema:[1,4],configur:0,model:5,shut:2,conf:0,gener:4,view:6},objects:{"":{schema_bot:[1,0,0,"-"],controller:[2,0,0,"-"]},"view.schema_view":{SchemaView:[6,3,1,""]},"model.schema.Hierarchy":{hierarchy:[5,4,1,""],get_schema:[5,2,1,""]},"model.schema.SchemaClassGenerator":{run:[5,2,1,""]},"model.schema.SchemaClass":{generator_callback:[5,2,1,""],start:[5,2,1,""],get_parent_class:[5,4,1,""],clean:[5,2,1,""],get_schema_body:[5,2,1,""]},controller:{EZContext:[2,3,1,""],EZQuit:[2,3,1,""],Controller:[2,3,1,""]},model:{schema:[5,0,0,"-"]},"model.schema":{SchemaClass:[5,3,1,""],Hierarchy:[5,3,1,""],SchemaClassGenerator:[5,3,1,""]},"controller.EZContext":{get_keys:[2,4,1,""],get:[2,2,1,""]},"controller.Controller":{run_this:[2,2,1,""],server_close:[2,2,1,""]},"view.schema_view.SchemaView":{get_index:[6,2,1,""],generate_schema_output:[6,2,1,""],ajax_properties:[6,1,1,""],show_schema_properties:[6,2,1,""],get_saved_output:[6,1,1,""]},view:{schema_view:[6,0,0,"-"]}},terms:{query_str:[2,6],urlopen:2,s_gen:5,later:3,actual:5,error:2,localstorag:[3,6],code:[1,4],cron:[1,4],begin:2,action:3,except:2,depend:3,schemaclassgener:5,command:2,after:[1,5],bot:[],forc:5,saveschema:3,messag:3,fetch:1,onli:3,creat:[4,5,6],file_nam:1,locat:[0,1,3],innerhtml:3,"_version":5,everi:1,properti:[5,6],insid:1,found:2,"while":[1,2],b_immedi:5,construct:2,retriev:5,everyth:1,schemaclass:[5,6],run:5,cannot:2,languag:4,"__main__":1,instanc:4,thei:4,toggl:3,get_parent_class:5,aliv:1,parent:5,form:3,geo:4,brand:0,browser:2,png:0,"class":[1,2,5,6],becom:5,chdir:1,python3:[1,2],obtain:[3,2,5],name:[4,5],level:[3,6],snippet:0,localhost:[0,2],correct:[1,3],commonspot:4,paramet:[2,5,6],togeth:3,softwar:4,fals:5,gov:4,app:4,hide:3,geocoordin:4,amp:4,view:[],dir:1,"_hierarchi":5,"_property_typ":5,instead:3,flow:2,show_schema_properti:[5,6],join:5,manag:2,improv:[3,4],invok:2,schema_view:6,comput:[1,2],is_al:[1,5],"_traverse_hierarchi":6,websit:4,site:0,"__file__":1,cours:1,secur:2,favicon:0,all:[0,3,4,2,5,6],"try":2,common:4,ezquit:2,where:[1,3,2],chang:1,park:4,yell:4,element:3,same:[1,5],callabl:2,here:2,file:[0,1,3,4,5],happen:1,alreadi:3,applic:[0,1,3,4,2,5,6],base:1,inform:[],structur:[0,1,3,4,2,5,6],size:5,effect:6,necessari:1,run_thi:2,thing:5,input:[2,5],modul:4,shown:[1,3],must:2,demon:2,"import":[1,2],quit:[0,2],www:4,manual:0,utf:5,span:4,complet:5,execut:3,concern:2,output:6,next:3,arg:3,indic:[],back:5,thread:[2,5],place:6,"function":[1,3,4,5,6],need:0,parknam:4,doesn:1,apach:0,concurr:[4,5],internet:5,repres:2,empti:[3,2],confirm:3,seo:4,displai:3,exampl:3,work:0,under:2,div:[3,4,6],content:[0,3,4],respons:2,more:2,callback:5,test:[0,1,3,4,2,5,6],method:[2,5,6],copi:3,petit:0,reduc:[0,5],would:0,consecut:1,call:[1,3,5,6],can:[0,1,3,4,2,5,6],job:[1,4],other:[0,3],javascript:[],cleardata:3,top:6,delet:3,txt:4,index:[0,1,3,4,6],button:3,field:3,storag:2,ezcontext:2,administr:0,finish:[1,5],meant:4,whether:5,submit:3,http:[0,4,2],persist:4,down:[],itemprop:4,contain:[2,5,6],yellowston:4,schema_nam:6,googl:[2,6],analyz:5,context:6,set:[3,4],recoverdata:3,print:1,recurs:6,version:[1,4,5],clean:5,root:3,hierarchi:[1,3,4,5,6],latitud:4,respect:6,proxypassrevers:0,generate_schema_output:6,done:5,get_kei:2,hasmap:4,via:1,dump:5,onc:3,balanc:[0,4],jqueri:3,avail:[0,3],main:1,program:4,directori:0,number:2,longitud:4,otherwis:5,thi:[0,1,3,4,5,6],recoveri:3,argument:6,etc:[0,1],readm:4,itemscop:4,onload:3,maintain:[4,5],save:3,side:4,schema:[],from:[1,3,2,5],noth:[2,5],subdirectori:3,safe:5,link:0,generator_callback:5,recommend:0,server:[],origin:3,refer:4,when:[0,5],todo:[0,3],between:3,alphacod:4,privat:6,url:[4,5],port:[],line:2,list:[5,6],"__name__":1,urlerror:2,urllib:2,access:2,cfm:4,object:2,org:[0,1,3,4,2,5,6],htm:[0,4],date:4,"return":[0,3,2,5,6],shownextschema:3,safeti:5,local:2,forward:0,get_saved_output:6,generateschema:3,reason:2,interchang:2,restart:[],recov:3,handl:[0,6],environ:2,whole:5,show:[3,6],customcf:4,send:3,get:[3,2,5,6],string:[2,5],screen:3,natur:1,less:2,model:[],shut:[],section:6,python:[4,2],kei:2,listen:4,"static":[0,1,3,6],see:5,system:0,decod:5,"_html":5,ajax_properti:6,tab:[0,3],independ:2,wsgi:2,full:[1,6],control:[],differ:[0,3,2,4],ico:0,"_callback":5,old:3,"_schema":5,ajax:[3,4],post:[3,2],rewriteengin:0,"public":5,data:[0,1,3,4,2,5,6],exist:1,serv:[4,2],outdat:1,store:[3,2,6],situat:3,"true":5,replac:3,get_schema_bodi:5,loop:1,below:1,itemtyp:4,check:[1,5],external_link:0,been:[1,3,5,6],still:0,develop:[3,4,2,6],load:[0,4],schemaview:[5,6],hour:1,schema_bot:1,stop:2,showmap:4,experi:6,ctx:6,"new":[0,1,5],str:6,clear:3,get_schema:5,publish:5,pickl:[1,5],tool:[0,1,3,4,2,5,6],httpd:2,page:[3,4,2],web:[0,1,3,4,2,5,6],goal:5,none:[3,5],syntact:3,block:[0,3],imag:0,valid:[4,2,6],order:5,markup:[4,5],pass:[1,2],proxypass:0,befor:5,gener:[],might:3,web_hierarchi:6,format:2,get_index:6,treat:2,updat:1,option:5,each:1,directli:[0,2],current:2,base_dir:1,proxypassmatch:0,server_clos:2,html:[0,1,3,5,6],through:[3,2],valu:2,rewriterul:0,type:[5,6],close:2,should:[1,3,4],map:[4,2],search:4,tri:5,readi:3,open:0,property_typ:[],request:2,quot:4,start_respons:2},titles:["Apache2 configuration","Schema bot","Controller","Javascript","Welcome to the Schema Generator documentation!","Model","View"],envversion:43,objtypes:{"0":"py:module","1":"py:staticmethod","2":"py:method","3":"py:class","4":"py:attribute"}})
--------------------------------------------------------------------------------
/docs (technical)/_templates/localtoc.html:
--------------------------------------------------------------------------------
1 | {#
2 | basic/localtoc.html
3 | ~~~~~~~~~~~~~~~~~~~
4 |
5 | Sphinx sidebar template: local table of contents.
6 |
7 | :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
8 | :license: BSD, see LICENSE for details.
9 | #}
10 | {%- if display_toc %}
11 |
53 |
83 |
104 |
105 |
54 |
82 |
55 |
56 |
81 | Search
57 |
58 |
59 |
64 | 60 | Please activate JavaScript to enable the search 61 | functionality. 62 |
63 |65 | From here you can search these documents. Enter your search 66 | words into the box below and click "search". Note that the search 67 | function will automatically search for all of the words. Pages 68 | containing fewer words won't appear in the result list. 69 |
70 | 75 | 76 |
77 |
78 |
79 |
80 | {{ _('Page Contents') }}
12 | {{ toc }} 13 | {%- endif %} 14 | -------------------------------------------------------------------------------- /docs (technical)/apache.rst: -------------------------------------------------------------------------------- 1 | Apache2 configuration 2 | ===================== 3 | 4 | A Web Server can be configured to reduce the load of the |Application Server| by handling static content. It is recommended to do this, as ``/quit`` will shut-down the |Application Server|. 5 | 6 | Static content: 7 | 8 | * index.html - generated by the |Schema bot|. 9 | * schema.js - the |javascript| file 10 | * external_link.png - image file used to indicate the link will open a new tab 11 | * favicon.ico - branding image 12 | 13 | .conf 14 | ===== 15 | 16 | The ``.conf`` file is located in the ``/etc/apache2/sites-available/`` directory. 17 | 18 | .. code-block:: apache 19 | 20 | RewriteEngine On 21 | RewriteRule (quit$)|(restart$) /index.html 22 | 23 | ProxyPassMatch (/$)|(.png$)|(.html$)|(.htm$)|(.ico$)|(.js$) ! 24 | ProxyPass / http://localhost:8000/ 25 | ProxyPassReverse / http://localhost:8000/ 26 | 27 | This snippet blocks the ``/quit`` and ``/restart`` petitions that would shut-down or restart the |Application Server|. ``http://localhost:8000/quit`` will still work, so a systems administrator can manually shut-down or restart the Application Server(s). |Schema bot| will restart the Application Server(s) when needed. 28 | 29 | The Web Server will return the ``index.html``, ``schema.js``, ``external_link.png`` and ``favicon.ico`` directly. 30 | 31 | The Web Server will forward all other petitions to the |Application Server| at ``http://localhost:8000/`` 32 | 33 | ** TODO: Load balance Apache to different ports 34 | -------------------------------------------------------------------------------- /docs (technical)/controller.rst: -------------------------------------------------------------------------------- 1 | Controller 2 | ========== 3 | 4 | .. automodule:: controller 5 | :members: 6 | 7 | Starting the server at default port 8000 8 | ======================================== 9 | 10 | The Application Server can be started directly from the command line 11 | 12 | .. code-block:: bash 13 | 14 | computer:~$ ./controller.py 15 | 16 | or 17 | 18 | .. code-block:: bash 19 | 20 | computer:~$ python3 controller.py 21 | 22 | Starting the server at another port 23 | =================================== 24 | 25 | A number of Application Servers can be started to serve at different ports. 26 | 27 | .. code-block:: bash 28 | 29 | computer:~$ ./controller.py 8001 & 30 | 31 | or 32 | 33 | .. code-block:: bash 34 | 35 | computer:~$ python3 controller.py 8001 & 36 | 37 | Shutting down the server 38 | ======================== 39 | 40 | The server can be shut down from a browser. 41 | 42 | .. code-block:: http 43 | 44 | http://localhost:port/quit 45 | 46 | or using Python 47 | 48 | .. code-block:: python 49 | 50 | from urllib.error import URLError 51 | from urllib.request import urlopen 52 | 53 | try: 54 | urlopen('http://localhost:{0}/quit'.format(port)) 55 | except URLError: 56 | pass 57 | 58 | Restarting the server 59 | ===================== 60 | 61 | The server can be shut down from a browser. 62 | 63 | .. code-block:: http 64 | 65 | http://localhost:port/restart 66 | 67 | or using Python 68 | 69 | .. code-block:: python 70 | 71 | from urllib.error import URLError 72 | from urllib.request import urlopen 73 | 74 | try: 75 | urlopen('http://localhost:{0}/restart'.format(port)) 76 | except URLError: 77 | pass 78 | -------------------------------------------------------------------------------- /docs (technical)/extra/Readme.txt: -------------------------------------------------------------------------------- 1 | Tool for generating a valid Scheme as proposed by Schema.org 2 | Copyright (C) 2016 - 2021 Hans Polak 3 | 4 | This program is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | This program is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with this program. If not, see<div itemscope itemtype="http://schema.org/Park">
28 | <div itemprop=geo itemscope itemtype="http://schema.org/GeoCoordinates">
29 | <span itemprop="latitude">44.4279668</span>
30 | <span itemprop="longitude">-110.5906437</span>
31 | </div>
32 | <span itemprop="hasMap">http://www.nps.gov/common/commonspot/customcf/apps/maps/showmap.cfm?alphacode=yell&parkname=Yellowstone</span>
33 | <span itemprop="name">Yellowstone</span>
34 | <span itemprop="url">http://www.nps.gov/yell/index.htm</span>
35 | </div>
36 |
18 |
22 |
19 |
20 |
21 | 20 |
23 | 24 | 25 |
26 |
27 | 28 | 29 | 30 | 31 | 37 | 38 | 39 | -------------------------------------------------------------------------------- /src/schema_bot.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | """ 3 | Bot for fetching the |Schema.org| |external_link| full hierarchy to generate the ``Hierarchy.pickle`` file 4 | 5 | The Bot class will check for the existence of the pickle file and for the version 6 | 7 | * If the file doesn't exist, it will be generated by the Bot 8 | 9 | * If the file is outdated, it will be updated by the Bot 10 | 11 | After updating the ``Hierarchy.pickle`` file, a new static ``index.html`` will be generated 12 | 13 | The Bot should be called via a ``cron`` job every 24 hours 14 | 15 | * The Application Server |Controller| (or Controllers) will be restarted if necessary 16 | """ 17 | from os import remove, makedirs 18 | # Refer to the Readme.txt file for © copyright information 19 | from pickle import load 20 | from shutil import rmtree 21 | from threading import Thread 22 | from time import sleep 23 | from urllib.error import URLError, HTTPError 24 | from urllib.request import urlopen 25 | from zlib import decompress, MAX_WBITS 26 | 27 | from model.schema import SCHEMA_ORG 28 | from nqparser import treat_file 29 | 30 | HIERARCHY_FILE = 'Hierarchy.pickle' 31 | READ_BINARY = 'rb' 32 | WRITE = 'w' 33 | WRITE_BINARY = 'wb' 34 | 35 | 36 | class Bot(Thread): 37 | def __init__(self): 38 | Thread.__init__(self) 39 | # Public attributes 40 | self.debug = False # Running locally 41 | self.updated = False 42 | self.error = None 43 | self.version = 0.0 # Version of Schema.org 44 | 45 | # Private attributes 46 | self._is_alive = True 47 | self._schemas = {} # Dictionary for rapid access 48 | 49 | def run(self): 50 | is_dirty = False 51 | try: 52 | # First load the existing HIERARCHY_FILE 53 | with open(HIERARCHY_FILE, READ_BINARY) as f: 54 | pickle_list = load(f) 55 | self.version = pickle_list[0] 56 | except FileNotFoundError: 57 | # HIERARCHY_FILE is not there 58 | is_dirty = True 59 | 60 | if self.debug: 61 | is_dirty = True 62 | self.version = 0.0 63 | 64 | # Check the version of the Hierarchy against the known version 65 | i_tries = 0 66 | txt = None 67 | while i_tries < 9 and txt is None: 68 | i_tries += 1 69 | try: 70 | with urlopen(f'{SCHEMA_ORG}docs/releases.html') as f: 71 | txt = f.read() 72 | if 31 == txt[0]: # If the txt is compressed, decompress 73 | txt = decompress(txt, 16 + MAX_WBITS) 74 | except URLError: 75 | # Wait a millisecond before trying again 76 | print('Sleeping Schema_bot... waiting for version') 77 | sleep(0.1) 78 | 79 | if txt is None: 80 | # Abandon ship 81 | self.error = 'Schema bot abandoned. Check Internet connection' 82 | return 83 | 84 | # Check the version 85 | #
sdo-ganymede
(2015-08-06)
15 |
16 | 
17 |
18 |
23 |
17 |
18 |
19 | schema.org release: {version}
20 |
21 |
22 |
24 |
55 |
64 |
75 | EUR
76 | info@polak.es
77 | 2015-01-01
78 | Hans Polak
79 | Paypal, Electronic Funds Transfer
80 | X2.125.374J
81 | +34 669.765.160
82 | http://polak.es
83 | ES.X21.253.74J
84 |
92 |
93 |
96 |
97 |
98 |
--------------------------------------------------------------------------------
/src/view/logo_gen.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/src/view/logo_gen.jpg
--------------------------------------------------------------------------------
/src/view/logo_gen.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/src/view/logo_gen.png
--------------------------------------------------------------------------------
/src/view/robots.txt:
--------------------------------------------------------------------------------
1 | # robots.txt for http://schema.pythonanywhere.com/
2 |
3 | User-agent: *
4 | Allow: /
5 |
--------------------------------------------------------------------------------
/src/view/schema_bot.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
56 |
59 |
60 | {output} 61 |
62 |
63 | 60 | {output} 61 |
16 |
17 |
18 |
31 |
38 |
39 |
40 |
--------------------------------------------------------------------------------
/src/view/schema_bot.js:
--------------------------------------------------------------------------------
1 | function onLoad()
2 | {
3 | setTimeout(function(){CheckResult();}, 1000);
4 | }
5 |
6 | function CheckResult()
7 | {
8 | // Get the next level with AJAX (but only once)
9 | var div = document.getElementById("result");
10 |
11 | // This code gets executed only once per level
12 | var params = "check=true";
13 |
14 | var http;
15 | if(window.XMLHttpRequest) // code for IE7+, Firefox, Chrome, Opera, Safari
16 | http=new XMLHttpRequest();
17 | else // code for IE6, IE5
18 | http=new ActiveXObject("Microsoft.XMLHTTP");
19 |
20 | // Prepare the request
21 | http.open("POST", "/schema_bot", true);
22 |
23 | // Prepare the proper header information to send along with the request
24 | http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
25 | http.setRequestHeader("Content-length", params.length);
26 | http.setRequestHeader("Connection", "close");
27 |
28 | // Prepare function for asynchronous reception
29 | http.onreadystatechange=function()
30 | {
31 | if (http.readyState==4 && http.status==200)
32 | {
33 | if(http.responseText === "Busy")
34 | {
35 | div.innerHTML+="."
36 | setTimeout(function(){CheckResult();}, 5000);
37 | }
38 | else
39 | div.innerHTML=http.responseText;
40 | }
41 | }
42 |
43 | // Send the request
44 | http.send(params);
45 | }
46 |
--------------------------------------------------------------------------------
/src/view/schema_header.html:
--------------------------------------------------------------------------------
1 |
2 |
32 |
36 |
37 | Schema Bot
33 |Updating the schema version.
34 |Just a second...
35 |3 | schema.org 4 |
5 |
6 |
18 |
19 |
--------------------------------------------------------------------------------
/src/wsgi.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/python3
2 | from controller import app
3 |
4 |
5 | if __name__ == "__main__":
6 | from os import chdir
7 |
8 | print('Schema Controller - main')
9 |
10 | # Change the base dir to where this __file__ is located
11 | # Needed for testing
12 | # FILE_NAME = 'wsgi.py'
13 | FILE_NAME = __file__[__file__.rindex("/") + 1:]
14 | if __file__ != FILE_NAME:
15 | BASE_DIR = __file__[:__file__.index(FILE_NAME)]
16 | chdir(BASE_DIR)
17 |
18 | try:
19 | # This will setup the server and start the serve_forever() loop
20 | # This will block the script until the serve_forever() loop is interrupted
21 | app.run(cloud=True)
22 |
23 | except KeyboardInterrupt:
24 | # Silence KeyboardInterrupt exception
25 | pass
26 | except Exception as e:
27 | print(e)
28 | exit(-1)
29 |
--------------------------------------------------------------------------------
/tests/__pycache__/test_controller.cpython-34.pyc:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GUI-Junkie/Schema.org-Generator/6e5f915bed963f7e1028927c28eb823ec30ded71/tests/__pycache__/test_controller.cpython-34.pyc
--------------------------------------------------------------------------------
/tests/test_controller.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/python3
2 | from cProfile import run, Profile
3 | from http import client
4 | from os import getcwd
5 | from pstats import Stats
6 | from subprocess import Popen, PIPE
7 | from time import sleep
8 | from unittest import TestCase, main
9 | from urllib.error import URLError
10 | from urllib.parse import urlencode
11 | from urllib.request import urlopen
12 |
13 | WRITE = 'w'
14 |
15 |
16 | def get_connection():
17 | sleep(1) # It's necessary to wait a second for Popen or /restart to do it's thing
18 | try:
19 | urlopen('http://localhost:8000')
20 | except URLError:
21 | return False
22 | return True
23 |
24 |
25 | class Test(TestCase):
26 | cli = None
27 | is_running = None
28 | profiler = None
29 | pipe = None
30 |
31 | @classmethod
32 | def setUpClass(cls):
33 | cls.profiler = Profile()
34 | cls.profiler.enable()
35 |
36 | # Check if the server is running
37 | pipe1 = Popen(["ps", "aux"], stdout=PIPE)
38 | pipe1.wait()
39 |
40 | pipe2 = Popen(["grep", "doController.py"], stdin=pipe1.stdout, stdout=PIPE)
41 | pipe1.stdout.close()
42 |
43 | pipe1 = Popen(["grep", "-v", "grep"], stdin=pipe2.stdout, stdout=PIPE)
44 | pipe1.wait()
45 | pipe2.wait()
46 | pipe2.stdout.close()
47 |
48 | procs = pipe1.communicate()[0]
49 | # If the server is running, we keep it running
50 | if b"doController.py" in procs:
51 | urlopen('http://localhost:8000/restart')
52 | cls.is_running = True
53 | else:
54 | # If the server is not running, start it for the duration of the tests
55 | cls.pipe = Popen(['python3', f'{BASE_DIR}/src/controller.py'])
56 |
57 | i = 0
58 | while not get_connection() and i < 100:
59 | i += 1
60 | cls.cli = client.HTTPConnection('localhost:8000', timeout=100)
61 |
62 | @classmethod
63 | def tearDownClass(cls):
64 | if cls.is_running:
65 | return
66 | urlopen('http://localhost:8000/quit')
67 | cls.cli.close()
68 | cls.pipe.wait()
69 | p = Stats(cls.profiler)
70 | p.strip_dirs()
71 | p.sort_stats('cumtime')
72 | # p.print_stats()
73 | # print("\n--->>>")
74 |
75 | def testURLOpen(self):
76 | with urlopen('http://localhost:8000') as f:
77 | txt = f.read()
78 | self.assertIn(b'/Thing', txt, "Oh, bloody hell!")
79 |
80 | def testQuery(self):
81 | d = {'DateTime': '', 'URL': '', 'Text': '', 'next_element': 'ActionStatusType'}
82 | t = d['next_element']
83 | self.assertEqual(t, 'ActionStatusType', f'testQuery: {t}')
84 |
85 | def testAjax(self):
86 | test_file = f'{TEST_DIR}/ajax.html'
87 | txt_html = ''
88 | if not CHANGED_FILES:
89 | with open(test_file) as f:
90 | txt_html = f.read()
91 |
92 | data = {'next_element': 'ActionStatusType',
93 | 'id': 'LoseAction_actionStatus_ActionStatusType',
94 | 'select_id': 0}
95 | data = bytes(urlencode(data).encode())
96 | with urlopen('http://localhost:8000/ActionStatusType', data) as f:
97 | txt = f.read().decode()
98 |
99 | # If the output doesn't coincide, there may be another version of Schema.org
100 | if CHANGED_FILES:
101 | with open(test_file, WRITE) as f:
102 | f.write(txt)
103 | else:
104 | self.assertEqual(txt, txt_html, 'test_Ajax')
105 |
106 |
107 | if __name__ == "__main__":
108 | # CHANGED_FILES = True
109 | CHANGED_FILES = False
110 | BASE_DIR = getcwd()
111 | BASE_DIR = BASE_DIR[:BASE_DIR.index('/tests')]
112 | TEST_DIR = f'{BASE_DIR}/tests/test_files'
113 |
114 | # Try to connect to the server
115 | # If a connection can be made, tell the server to restart
116 | try:
117 | cli = client.HTTPConnection('localhost:8000', timeout=1)
118 | cli.connect()
119 | cli.request("GET", '/restart')
120 | cli.getresponse()
121 | sleep(0.1)
122 | except ConnectionRefusedError:
123 | pass
124 |
125 | main()
126 |
127 | # python3 -m cProfile -s cumtime doController.py
128 | # python3 -m cProfile -s cumtime doController.py | grep controller
129 | # python3 -m cProfile -s cumtime doController.py | grep schema
130 |
--------------------------------------------------------------------------------
/tests/test_files/ajax.html:
--------------------------------------------------------------------------------
1 | -
7 |
-
8 | Schema.org
9 |
10 | -
11 | Schemas
12 |
13 |
-
14 | Documentation
15 |
16 |
2 |
21 |
--------------------------------------------------------------------------------
/tests/test_files/mo_better_levels.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
3 | Add property:
19 |
20 |
17 |
18 |
19 |
50 |
81 |
93 |
104 |
112 |
113 |
114 |
115 |
--------------------------------------------------------------------------------
/tests/test_files/one_level.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
51 |
75 |
76 |
52 | schema.org release: 3.1
53 |
54 |
74 | 75 |
77 |
79 |
80 | You can check the generated Schema here.
78 |
17 |
18 |
19 |
50 |
69 |
81 |
92 |
100 |
101 |
102 |
103 |
--------------------------------------------------------------------------------
/tests/test_files/test_get_breadcrumbs.html:
--------------------------------------------------------------------------------
1 | Canonical URL: http://schema.org/Dentist
51 |
63 |
64 |
52 | schema.org release: 3.1
53 |
54 |
62 | 63 |
65 |
67 |
68 | You can check the generated Schema here.
66 |2 | 18 | 34 | 55 | 76 | 92 |
93 | -------------------------------------------------------------------------------- /tests/test_files/three_level.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 |
17 |
18 |
19 |
50 |
78 |
90 |
101 |
109 |
110 |
111 |
112 |
--------------------------------------------------------------------------------
/tests/test_files/two_level.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
51 |
72 |
73 |
52 | schema.org release: 3.1
53 |
54 |
71 | 72 |
74 |
76 |
77 | You can check the generated Schema here.
75 |
17 |
18 |
19 |
50 |
72 |
84 |
95 |
103 |
104 |
105 |
106 |
--------------------------------------------------------------------------------
/tests/test_schema.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/python3
2 | from unittest import TestCase, main
3 | # from unittest import skip
4 | from urllib.error import URLError
5 |
6 | from model.schema import Hierarchy
7 |
8 |
9 | # @skip("Skip TestHierarchy")
10 | class TestHierarchy(TestCase):
11 | schema = None
12 |
13 | @classmethod
14 | def setUpClass(cls):
15 | cls.schema = Hierarchy()
16 |
17 | @classmethod
18 | def tearDownClass(cls):
19 | del cls.schema
20 |
21 | def test_get_parent_class_WearAction_from_Hierarchy(self):
22 | func = self._testMethodName
23 | # print(self.schema.hierarchy)
24 | try:
25 | schema_class = self.schema.get_schema('WearAction')
26 |
27 | rs = schema_class.get_parent_class # Get the parent
28 | test_list = [['Thing', 'Action', 'ConsumeAction', 'UseAction']]
29 |
30 | self.assertEqual(test_list, rs, f'Value: {func}')
31 | except URLError as e:
32 | raise e
33 |
34 | def test_get_schema_class_from_Hierarchy(self):
35 | func = self._testMethodName
36 | try:
37 | schema_class = self.schema.get_schema('Thing')
38 |
39 | self.assertEqual('Thing', schema_class.name, f'Value: {func}')
40 | except URLError as e:
41 | raise e
42 |
43 | def test_check_properties(self):
44 | func = self._testMethodName
45 | try:
46 | schema_class = self.schema.get_schema('Thing')
47 |
48 | rs = sorted(schema_class.properties.keys())
49 | # print(rs)
50 | self.assertTrue('url' in rs, f'Value: {func}')
51 | except URLError as e:
52 | raise e
53 |
54 | def test_get_properties(self):
55 | func = self._testMethodName
56 | try:
57 | schema_class = self.schema.get_schema('Thing')
58 |
59 | rs = sorted(schema_class.properties.keys())
60 |
61 | self.assertEqual('additionalType', rs[0], f'Value: {func}')
62 | except URLError as e:
63 | raise e
64 |
65 |
66 | # @skip("Skip TestPropertyTypes")
67 | class TestPropertyTypes(TestCase):
68 | def testAddProperties(self):
69 | p = set()
70 | p.add('URL')
71 | p.add('Text')
72 | p.add('URL')
73 | p.add('Text')
74 | p.add('URL')
75 | p.add('Text')
76 | p.add('URL')
77 | p.add('Text')
78 |
79 | # print(p)
80 | self.assertEqual(p, {'Text', 'URL'}, 'testAddProperties')
81 |
82 |
83 | if __name__ == "__main__":
84 | from os import chdir
85 |
86 | BASE_DIR = f'{__file__[:__file__.index("tests")]}src/'
87 | chdir(BASE_DIR)
88 |
89 | main()
90 |
--------------------------------------------------------------------------------
51 |
66 |
67 |
52 | schema.org release: 3.1
53 |
54 |
65 | 66 |
68 |
70 |
71 | You can check the generated Schema here.
69 |