From 733af3d0880782216dc045b531a98d88c99ed8f4 Mon Sep 17 00:00:00 2001 From: EstherLerouzic Date: Tue, 25 Feb 2025 17:05:39 +0100 Subject: [PATCH] add missing tox and config files Signed-off-by: EstherLerouzic Change-Id: Idabe9dfdc1827bf88f614b66eef1546728b15c1f --- docs/biblio.bib | 13 +++ docs/conf.py | 187 ++++++++++++++++++++++++++++++++++++++ docs/images/GNPy-logo.png | Bin 0 -> 21042 bytes docs/index.rst | 20 ++++ docs/intro.rst | 4 + docs/make.bat | 36 ++++++++ setup.cfg | 68 ++++++++++++++ setup.py | 5 + tests/__init__.py | 1 + tests/test_api.py | 10 ++ tox.ini | 44 +++++++++ 11 files changed, 388 insertions(+) create mode 100644 docs/biblio.bib create mode 100644 docs/conf.py create mode 100755 docs/images/GNPy-logo.png create mode 100644 docs/index.rst create mode 100644 docs/intro.rst create mode 100644 docs/make.bat create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 tests/__init__.py create mode 100644 tests/test_api.py create mode 100644 tox.ini diff --git a/docs/biblio.bib b/docs/biblio.bib new file mode 100644 index 0000000..2a67c67 --- /dev/null +++ b/docs/biblio.bib @@ -0,0 +1,13 @@ +@inproceedings{LeRouzic:21, +author = {E. Le Rouzic and A Lindgren and S. Melin and D. Provencher and R. Subramanian and R. Joyce and F. Moore and D. Reeves and A. Rambaldi and P. Kaczmarek and K. Weeks and S. Neidlinger and G. Agrawal and S. Krishnamoha and B. Raszczyk and T. Uhlar and R. Casellas and O. Gonzalez de Dios and V. Lopez}, +booktitle = {Optical Fiber Communication Conference (OFC) 2021}, +journal = {Optical Fiber Communication Conference (OFC) 2021}, +keywords = {Erbium-doped fiber amplifiers; Modes; Optical circuits; Optical components; Optical networks; Optical systems}, +pages = {M1B.2}, +publisher = {Optica Publishing Group}, +title = {Operationalizing partially disaggregated optical networks: An open standards-driven multi-vendor demonstration}, +year = {2021}, +url = {https://opg.optica.org/abstract.cfm?URI=OFC-2021-M1B.2}, +doi = {10.1364/OFC.2021.M1B.2}, +abstract = {We present and demonstrate service provisioning in partially disaggregated multi-vendor network automation scenarios with online physical impairment validation. This work uses and extends standard interfaces (OpenConfig and ONF Transport API) to retrieve network information interacting with TIP GNPy tool.}, +} diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3db0423 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,187 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# gnpy-api documentation build configuration file, created by +# sphinx-quickstart on Mon Dec 18 14:41:01 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# 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('../')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# 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.autodoc', + 'sphinx.ext.mathjax', + 'sphinx.ext.githubpages', + 'sphinxcontrib.bibtex', + 'sphinx.ext.graphviz', + 'myst_parser', + ] + +myst_enable_extensions = [ + "deflist", + "dollarmath", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +source_suffix = ['.rst', '.md'] + + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'gnpy' +copyright = '2018 - 2025, Telecom Infra Project - OOPT PSE Group' +author = 'Telecom Infra Project - OOPT PSE Group' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- 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' +html_theme_options = { + 'logo': 'images/GNPy-logo.png', + 'logo_name': False, +} + +html_logo = 'images/GNPy-logo.png' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# 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 = [] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'gnpyapidoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'gnpyapi.tex', 'GNPy API Documentation', + 'Telecom Infra Project - OOPT PSE Group', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'gnpyapi', 'GNPy API Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'gnpyapi', 'GNPy API Documentation', + author, 'gnpyapi', 'One line description of project.', + 'Miscellaneous'), +] + +autodoc_default_options = { + 'members': True, + 'undoc-members': True, + 'private-members': True, + 'show-inheritance': True, +} + +graphviz_output_format = 'svg' + +bibtex_bibfiles = ['biblio.bib'] diff --git a/docs/images/GNPy-logo.png b/docs/images/GNPy-logo.png new file mode 100755 index 0000000000000000000000000000000000000000..3618ea591b9e90f9f09b83fa58c6079582da525a GIT binary patch literal 21042 zcma&NRZv`Av@VLfy9al7cL)x_-QC?GxVty*8eAK9cY?dSL-6GEf9md+d-ubwS`=Lr zvwHSgbBxbMN2@4(M@Aq(00RRK zc6G9}v9};~_i?r$weYsF1OxNlsLj?&p#-K&{cDWTf%qM&jZ(UP6*N`gwoTD2iJL=2 zz|cisOtHP+kEsQ=KP&S0rSso@Vi}%6+lCy=$Ro|m*5RJw<88qU*X!r!$ES`_A7WqN z&EVhe_-<;$rH@!w;Z;=O_HR7DKi~ZSz5{D6128wO3g=jQVHA8_k7hm<9ynBDZcq0g z|JD7xA$+Si_W#@VcPIbgRIBgnXC0Io;bGa?foxvibq{IJPuQRFKOy_fl&T(tA30Rz z_U9ViIKKG2cW(n@^S%|#E!7t}_xdx__Klo9`ZS1)-9*o`=zQEC83nSr$^1PP5gEDJ z*}f6Fy^v;>tnQdA?#+1UJ`@khUUJjhuXtGXHYzBXRW^%`jdSRe>3^CECn2BfC5t4M z?${TsXJ9PPI*d+V#nV!lvtn9aJCu_P9xND&=X!22usyO#ZXX`I_ha7oar~LzE`B&6 z;B0|}gwt`zB66er?JteUF64F%2I@dNk5U@+V+_4edC~N_Q5`wiexRwXvVXz17q#uz z0*svTLLn1JM(5Wz6gH;M%G#$RK9{_=tIth>qMJFeuqZ3SRQPD5SB#W!4FCAX2vH)! zH~eYAav~ahI7=5;uL(uD@S~PWD>r52xz>e)54L%6azos|%`AGrBgdtt*>njWndwzURx&D}LWXBT*tq zwuCxNq8F+ehUH6W`N2>C_tUN!<*tKu@ZeDx&TQT`>{K@?Q zu%D)NDxdt#ZWl3kh<#Z}ZEQ!xRx4ocAC;ou{tKD-@B9*P+O%PmT|kJUL2e0?`BG?^ zJ3?>s1q}vEPk9gWu}~dVsKBO5W2JE}s(IB{;(G70rR&cb6VqnnZ{e96>{uexM!#N; zr%u`VaKCa#Vt}6Pv_X4Zy3(d5tO|jAU)8JRtDHp@*-IXO_lmuSv)kIVgI0KVI_8jl zo7fSX(nf|d8S0+BuondK`f!6tU+1pK>$S&AmK$L-SD19^xVm~4H{vwc211!sajHQM z#c#JZ9hEA!NOp8u0fKg=i@j+B%V1A`ev6r|_OiUFz3h(+S(D$%n;sJ^kYY7&sg4A8 zBU@a?HivO-YI<*@;tolX-Bnuk-I6QSVF}mDJ}H-hlkECwJi`>Uq)tW4atEWrYWA(% zS-5j`u@-rkiM#2lE!}W6imT_TjZ3tr5rdQtYwKuuf!e|G43tGk?g2pKOy()`0K0Ve!N z@Q*or?+*XV29*Pe&J=xe$1l%-;5wVR))GI8Z9go=+Gc4$1&bwK;>`NogS1$I2d?N# z7^?-B^KSgrH4M_R;h}R7q|SwhZl8rD$K)lB-nDBho8(z-T5-Skzm#0C|52N0c zKKPpJ4gFXzwM4(t9Zee(63A$};=n(Rtd=%=Dqgd33T()#4=IcLS{p74hT+ z^52^<%3D1-4$<;Fe$Xi|g9~o=Bc7v6S_n9^fysyTr|-}GYVSygTplP{X>Gu;vkh8f zRwq&WB|{=X+}egmXBQ@PvL&D&+s2U>fvIBj+2KSQIiVA0(K<5Xh^NgqU)qKnT7w?ugv#6K+IEU*LzRZ_YM<{%^`?gyhf)3o_p^}fypT-|Vme+(J&IFy_eTK zc24p+0O=@Sy)svRAp;V+4SYWjYKOuuWYR6u4=P}K0EKZ%gYEc+~<)3gx7 z$FUs#6*nvAEt%^+WGb4nthKCMdKwoa$onh7Cr^${9IPK7QD(hT)cOr+o_2}+F9d_t z(}8tl#YgJhaq13y>#7g%QJ+4784!k$K>9nq_j-O>p#e%8(qgO>4;&fBt@^ibQ2wS+ zuyr|t2V$|cRVAxY^|Us3S*-Yw7}A_6bfI_6eNz-Yu6C9TL{1KNg)@O-6MoxjXw$Da zh4wnp16H~{9@ZC6AxE$%NsJCp1ooq&6xKGdf3&D4qSfcPNMZbKA!rTJ`84vVyWl2N34QzjVW%Tj0QORP2XpzbLh#7STS@ z`pe%`jy}uq0EL_o8r@E?k44?!!C;PI7LY;(j6YJ{Ej`bJ_}mAe&|4HV9n})fD+kH! zCp*l<$^O6$l#x1s(=HJHXuOa%VnuIv78T;Q{JF$8I1BOUB`z9w7U%JahJ#5ZDQVa6 zFRVK{$Wlhfhh3_gxI`Bp@6v=XhYTf(9`!LJn#9Yr$WBT>~`vC)u@FJx45 zBnY$)n*0RB8v~VunwoqgT!hecF^+LfZYrerf$Id~Jyb!s=9Q49P=ymnqArA=6TF1$ z5oS^Z8=~imP=2~S*Htx@;upB$QhdQpG`C>v$q?*$8$~vMD13T((__9B{?wzLy%9$K zXhMV&Z(oG93zFel{M?z0V+77y;UgkvKq!S}MwU#3Scm&nmvoEn-%M@w7RK|>gzZHH z3CIxp*m&9cfN@-J)DjQlK`15m2=P<^! zFt_+^{vIu-0rx_H!$u`wTof6g7$zl^S2Hd>i>cYH(p4;`04Hz;|I^?*4x3Pjb9K#; zHN3krdxL_v_FCw|!B@({2wrlBS(q3R)RSbJ#C0r5QlBM(EeGevmcM(UR~$Pjod%El z!%d3>Dor{}R4j>;p;+#Rt&FSxH)6D+W<_~1JyCCr$ut;NFGi?*qH;`@B|a$FeVzHz zGeSww)-ZX$hgW=ObsmT)BUH(Uig?AK_bEz*Qz^%$ABK3imRoIxD1;x1xZ2Q?W1a~= zGhlzWhGWyu7Trx!r&-~##9hXVdhtH59e*P9wRA#*?Z}dsOhBSgMRYG}u>-HbGu4+t z;)Hfs(BSD*n37xxX_Ti-d5w99TMr#*lTq{RAZPA&JgA(nGBI6 z@Qh-I%%3W|o(%MyrgegIwS3Kef=2jAJHP9-R*=ccQFN+EZ(uim5ICq69D;@tR*uWIO64NOJ-Qk>%ZQQ^= zFel6zK3USuBgbW69l8?s*|U;35VS^%xIuUtp+303{62^YE!!Ayj&`%HT4oMo&`JQu zo91O~6MDqiC7G5j&E72QuST0*rt#es4W$Y5PF^3c4G{=cj7>Ue^2D8+STadB0;0|G zIF-U*Mf6>zPzc>QLj=Q#Iux7jGZhIBnGmt4`IN!T@HY@HpCwq}{;Uv( zW1?~z!B`3wko-Tov6$zz{r+GntlTu33nB$@#Jj)4RKv5?cI_w}%n?fufW^mAW9pVb zI+hr_6|vBbC;{#Z$2dfq@~H=-#|`=w&RUuJa<2K!!EVwrMD|#o;VKMB*@hF`DX=QH zKUm>0g(xP)53`frVVM$rk)keaF}*mu#JJJZBd_Y_n57q()mAi-F_LCsJd;ZBrtlG= z>f1)4oe0e>$vVCam+5fkt&u8ch;W=^ib^e$v^LO#wBe-88|C#LX|+XVsskz6cq%q6r7N*Qx-kv;l3p?+n?+8iJSCb)HLx7l;;%+#Nc_L|$JyWc_I z7hh=sPMCQ|x(6>K6_rA56=Ll+j*<>&vi^5{`&m1HEE2Zj;+`(Z-M=C@S%&#bb`>lP zks2kH3~?)Adc2{AO41jDj!dd*!rx?nChe{zfSH~FX zzVnT4n<0m=r@6oB*<*!8rH6S^?^>SZ?@zX(>ZJ*3EnQX&^*&ZZXK(JAQ&Bth6dZ3G zO6z2~aGbLhP}i28VAmzFt0jDa>$h*+{5x5lkj9`cR9K0t`$;4tyHleegH4@|4ad&e z@!8WVBqM|IH!WkE*9NzdyRe*5M4yf?-b3`3+ZneKf5W~Me!K~n3KpIQi5E5Ej#(H1 z-fc)5MNxkN`H*Q%>jZ#AZHuIV{ezIxWVBf%Sd#76t`}wg+%|*;9$bnTrz9^{>qyzL zN~5TP*ySM-ZRJ(fSNt1BkOzOLV~}LUa<{QTWZ+99PKehOn)kb`3{bRRBhz zfYCc9UT^AOzAO$(*TP}=m;R44?JH6fPT4ybnt%0PDI)b|gWeilVTEnZzXiKv-F653|B< zwQGY$o0co&c=)Odn7NC=uplqY7%{Je-%X`-`8gUFB2Xp~{Hw5tR}q%G;Smt=xl985 z1AY(nNfi14SSG;B#GAi|?Z|26%hlymB~m4cUZ0M>2CJ#&1}Jz+3P^78IpYFU^)?Z-FKgN)4=>k3U4Zblb%(439bgRx z!W=ez@HW&_c!*2XKCmMZG>*pCfbjyvLOVh@JtG_vTDvJf>AdQ&lKR>+LD43npG{ay z&R`bFr_z!^i#^7Gg={Lp2wg&?@l*^CM*<4Cz_^dP1XA-SYsnM2A@ym~ku~m^?Q|G@ z^CK+kU^qp5?b1JPx)0v+P?d(4i(_wSxEHcyO4Q%sh^5}0yJB}BmKWj?2i4xfx?~cF z^Njpc^N=mMdf0>ha{6&?Nj$x~t*im>Lj-vcjRssl2Ocs7>AP3r#5gTJsBP>(K<$f_zu$tFq3Kow$d# zQxYRz!^aKxVh6)ilR{&yG3HNRz%{VmC8i>HvMY)~esU|x*Q$hU*K7?)7!Z|gIkk?I zgE(mAkeg9=cnQwLHY;nMT+)$Vr2T>+jz2_6bG~Cv_C+!Jdj-X%f{1eMOe-295tZIrbN<|h!taaXQ zVL9h%y;s1_M$z0jmogGrkR6GmFzar(M1I?HX3x2~mDx2wanRwB=&DTZDMH4yR{oQz z8Hz~rckXGMv4Q5?S^~DMKa4D8w6MqqNr%>-ZxXv=e~;}VqTkP;$>tjoS9W<4Gn85K z*Zl^^61)HmkR$r&g%W~zD6EeV5$g=e{Gj?fHchGtEUO|n?1*;(i}HS^u^7FnGJrL} zXYXz1d=6VJesFQ+>D^UPmoOWs%?@$m68iQfjOy*ON4#h}{BMydD$J+D*#(=UKpd-J z8<|zo#t?};_Pl5x;srB0sZf9E<~1wPGcF9^(n45vs~FDVKlDpg>4bQLpS&-N7U1_} zG;&HR5$$zZ9&-gYw8(=`DZiO!&{Mc9!+(d&Khp2j2^+-bi2rgdvPJ#18(?!y35D9N zCHY~aV(rc;)}LzgXg=CSXXKh*@p#$_LozkSwHI|n&z2Kunfs&XvpUx!;VwI(W+w;*D;8^AF5D2-Pe36TuVY4V(P0rm&5(yV-xHuu${> zd_OA^buya<$ZPBTrsi8WdnpP(1B-$bAdz-k97=$Hi8PX8V zc^a)kE0bh=kbC=P_|kpLps@7m)lZAVsO=3m$T<_+zqC@)V7zZ4vqI5eJU|`=jff-0 zsNDc(IuIg-hKR!$qTOJOJ{$raOA1;7)%gGX%Zg|t$-v)!D1uHUc^+$m(NPvzjLMWS zgN)?x29kWKq`$(iV2TD6TZ@%;1RjbNzwLimw^p`tUUVv{@l;y#dq`B&IVqrNVDMVt zXEK^)Qsu^k$S2=d(hKLrNF=+^A}~u0RE@)tHCUUYms-uwd(bn*ir$vWB{^`8 zb85;KU1pu^e0_N83|7!WIdGdQ36MqRp;v?!4khSmIMc^SWjPG0J~~2jDORl6r&KM= zt`ab=+D>a-niDE=E)8=kPJj6p1))L61}XmlIP>9o@kR4qOXi_`dJ;Nnw8EL8o4*)m zQNKy2dIRN(bIGERcedy%SU3klfp>N)qJ=K4(vJOb{z@nSM4g{OtYxV zEMq}CEU+*qu$;v!ZED5Z;xDxx*amrw3JAm5G4knGL0U+haa2k%&~cao5IIpT z4qtjOmNdS=RnpImX+pdu4LPEh;uhsldm&IUQ!eT=r&$Y%OFNpp9HtJD;LeQ>=E6ZY zPJB5j!i>87vL*ON&EDOZTWSnc`#4$Iq1DK$`Tc6yGXY$n%@-sm z=xLU~&a)x~5-X=vF27xP$Fa57IB^&RT${Ecg>JrK)UzBpF&m*y}pk4R?kGE&u=8YN2Lgq)U;84`UXGjAt*AJ2XwE>koHsvggjK@}XwBwn4i zHT;`bO!ZRL$*AV)%$3 zK~(|Coqf@;$PVDp5*VYgai(lepcu&BHBM8-sQXRdS*|bXP_t-!?v}Yxy+*I%*RJfM z{X;X5%AAas82(R7SJ@LJAG4L~r>hCz*msEE05YVh{C>kfH=@pso8V@>xOnmMs3V`@ z4z#3cCc~o|Wum$s@3_VOl^Q-d6Xv z?9y*BB&&R)%sr!Eh6yTLP@3>DB?Hu;F|u0MjJ^5GXVr!)fjyZZB7 z|HYzQHw{l=Quy2X`Y#=6BStd1IdV>Zn~TG2s*M2=s@ zJ=|i}dKZ>S58n&7&Z_uME`Y%8kTQJk995qn8R<$hzAYDDFwLB_bvk(0iz&&WD6C}p zTC746g)|FakXau$!c7@DAxH4>Lx({MBR4+Wn;Hu*23-Kvv{Co4$J^Ctsqcdz)H-4U z7r@w;SYeGEbT>~n% z-wjp)Ol``VYZichv~vH|yc|L_9DqBQsP7-Rdg(vap_i`NKNzwLHBk8KMu?TofaCO|_u;NmS6?)tDfkIFFq|?C z70x%ko8B1U;BxRC7-WU7V25yegd$GaIA+3nb>yHhdeI&!dT;qVP<9uYOM)fB27vl8 zu~~bHh1dsBvW2tm7$L4xpVmQDiA3W#+B%CPdHzcw9qonPn6R6YjF%AEr9_>~ zM$uCzQm+g_tJx=?@Y{OoPO^|kBj?bbTpKHAT`;_V(xhvR$`)%Y1AH)f?I(>$2+<4c z@$=mf0Dd$NB^Dc1dsVsF=fTh1uxKSbtDgpntix*q0t1zejbCFBhPoRBb1#>k^A^9#_nRxPJu{^{Z&LU2*QVg+ z6p(z`U^e3>nxjj-&eyY}LAH)lOmc z`KPgM9F5t2B%?~v!Vw72ZoP_lSLPbW)9v#sO!p1!e(ZRJaJq-iE%LF)@5cyj#Z12? zvnHT4e%Dy?W=TGI6t@|=eT*Hkuy5*iyzr@7Kk!0y*^xhGoN5HO?VRn3=8XK>F{p{X z>WodVTYja@vC4|Du3ns^OpWG-7Jqdm-DyRcQL+1BZ}VwNHXE-GjyeAO;&W;nn%SJu z)gC6cmH#ovd-lUrOp_8Fds2crns?9h{>r-LdLBB+zh_``>Rho)`dm8oC%~w<*amdN z9;JHCnUFRpLH)+EX!zc_u=bag(SNkb5lb#h!hLDoBHD_)C?QorH)7y>)pSPt-KZUM zpkP;&BS8*zq(O=^-NSs@%D0$jIg6%Nm=Z@TC!qFJIz5l)LiaO&SP%_Fpi&qlG2~;{ z2)h#v`(`#;CH`pnQih|{$#FFL--~hZ1mA55zVDYLAaLM$2sdc#?2=AOuezeT7`^Mz zqVN=8iIWnTwX445$HlOb^JDz|M9aPlz}p8l;=%fp{C(ZSf)%PO@@%dE-lzg5~4SGUV6o)mOmUeTD=a$UN-1u-tpCP5Xqqf}aX>8I6vS3|#RV1Qj%2QLH7 zdj0q?23wxx%omwLio9*ytACCh0>T>oDnU*FPJ0u(Y0J`)=QigXCBUSplLt2ftk{!K zBpd(Koi}PrI+H30J~8%IDIUEE^|YfRUK> zqASL^U+N$mEbz7%)3|?k+C&Vr+UNi5?UD?XS?WdJCIw0`^ty#)QG3N47gavUi8~7u zm<}GEd+ThC*IwaoO;s$gD=?e8cK4(eu24%@W>IH0`~3Y2N+l(@(fJecQn9FN>veIX-8>d|sIk!=fu3rsZ?u5@R`BfXK1>kg z(_Zz5+;pVm*DdQ*qXzz&WR~?05R~o+g_~vFUsBJ|JH8n)RUF#$nquhEFw7>BzzAv2 z$awp5?W}pU^TU^Kg#jswdG3)|0cx3Y!*4P9k4xa+V83<}jFi=D^kpm-IK7REQs|}#Bl?+YCtyc=u&1O4!zIU$OVW!&- z!m2>_B_4yo6trCA_t%pnJdm)N_VZ?sr!JFDJ>!<9z8()z*V_<9RnO3T z*32XM<(TcCJo}=UtPb|Q$I&o9pY+6)9A0eRva_;XVDo_qh;izPM5LPZca9)wv#DlA{H&?rP-eP=iU5&AdB3ck^^G{&wniAIzjAY;h69u6z7zH#;H2G0 z)5}^6W~nD7Y|oyzzhiUxhm!}B*50B1t#Uk;sl~>myqejoeH-$>U-Yt<>I0A#V%fEA z)uBQZGE=Oy$kv~1H}1}skaT`+JA2!bKRYzD8uV*Y>sADI3aOK-cwT2dF;-)agZ(Q; zGNc^{pF15eOY6?DV4PWVB{E(oWlGIPwxEQSt$>>}emIJn)B)Yx?Zd8-y|0pGlOo&s zhb8tV##|m$iX{sgA!nhoNuX9=F*uO0LSb0-AjZGyHPX6yj8MOApx@p$4V6K!5y;kV z$_Jz4th?lXvF+YSkgep>4~NlEl^ZL?kCN|r#(&FHA@fw!vI|v*HT7vJtW*TVXkbp8 z{2aOl3Tb_NfdDa@HG2mjmH%e=U_>42Z*e6Zxcu0#tPRpwHzBRPCHtTCZm-=cHe0W$s zqBDCTOGGN+*^|fwqEu$sdWCqmwOccX$VQ1|9~)OB9k`3mftE3;ag(tk+BI|dA|g`!YLL@H~`GIl?7xWEdO4n1*1mNQtmTgaz8i^v+RtM$ z8k?3MUDtmsV;1GtlW9rN=f~0^(VZWULd4FJLv+FlK9($+2mkBn5$#VO>ugBk76*eN zZj{>Lq=Tr{nF(hrI=@cc!z|wCW8zR?(}e@S5^d$ffb!MSa?(&uiQF7`9Qr z>OqN}LtOxer>)JCoR~Say8Qkl+#(QLIYnCnB?u%CW+bzXW|@+&3;h#1a}_*&yrLOP znNZ8u%44bcS5SPxQFN%y)j%o%%7Gq5XAsoov5`GKw>%6^za+EOOHA0zu)lZTv{49n z{HL=L5D9;Ivj)q*k>9ek7d+9z4}^7f*&XD@Ol#ggUjwxv^sBqc-!GCkS3nL^XI}1| zAO1^+Gd%(Z!(wE1xrwps{Hl-p*|mRiBD)Xc;r%f<3jdXZ-|yIX>RT!fPLiTAc7@cb zH*%}ZU)7kRzfFvMz8kpyHi&6D#%gX-4BXR9%lA(9ls!=IpW;|xH6!6slG>t3`+iG_C}xXBqNX_I?Qc8`mhJZ?09lmV5c>gY*@)DORdUmOlTWz&tq?6#7+A(}|1vq?%oRs__1%^XRG(sixxY6zk-b2}EEGno@9KrM zqtrlee232_RO1x;-+%^EOlH_b2iB%O3p~aQ2LCjf`;`OsTV|?`?3sFnma{vd5+zvW z2uK_Tl79U%={gBk;lsy=ynA$zDaYU4sq9k z6EtWeO+gbR1aSy_5Qp%}NbygaO>we$@sQ+}J*ZrrVOYY9>&$cLyPZ%8LOkC}__K~o z04la^RX`Q@O&U2o=pMgba|_QLb^Ksdv$h!*ckaJF0w%+ag$CLaqa2$82TgG^S)d*0 z^BuI4hyh>)wOvrrYZ@r8-432KRh@T z{&v~ih1|EjvasuP#$Qm{Y>=09&|X!!xyIT` z5fVn^NlDhZ5-4!(if&VK&8G0mntTG%xs+*z7+aPqA}1l!+4ya)UKt0=dz}ArrNMf=hh04&TDyaZyWBrsd|6}pF_yGWCQZAgr|-=bZONVTY^zHB)HQ-n!=5qNOHZfsPeb{{rjL?Ia)uE(e3x4 z<>2vf8T}d-Aj45*mD6%c!!eUVoh!g7=OPRZbVl_uvaSfkLQn((HON-O-^Ge`OX_TR zzsU&6iQk!X4%-7eiza`Aih&D5T$Txo_oLPZ~ysP zR|lPh&4y$o%{JRFOW|1>;NTae(XzYn4DK7Fkt7C$&vP;7S>8YhijL{;^DWN@i!pSY z@qOdp3wbb~-aTSXq3OJPj}H$=+GF(RZKP?rMIoS54EUV>7XsC7;iY5}$7a zvI)LIUD?a$;aP_uFwRAZa@|i z7+v}=_iY=yPs>|=FLtC&uw8fxr8$6DtM_=KV#X_P-m#_4NcWUDn#US1A;O(H<6>je z<~hdDFMO!lY^&j7Q zjHUSY5TSXo?(W4)Cj6_WZ9K+$Tb@`w{#E4Dwi$RJ>+?GVaApV z@IjXmXFYbgJ?puZL#McE;5c@7t!;Tx{BEImSbK~`;i&b!DpoP0ae_TqF-sG39?4Ap zGEqa8{K6g0U^}8qy~>p??{LXJSiEL=iN|5h@o@Rv#nPWJ5yzlz<#kNpaXOPJC$IS%*GD~k{P|I_uSKXk66)gCUJluHqD1H~A`cX7Z zdkcXixF9j28_3F2trP9uIRg?Cpm)XJD#mkMZ+B!;7}Pw*0?T@-Vf%k1686os{ewam zXTA0)kujCG>uHP4FnL(1zPTVwHQOYQcFfkFJ@R%CR;pe&Qtg$Y1nh_HP63>axn|e> zyG>ImN4J=z^_4(9b&DAbm^R^7qF+>WEAnHIn{c;)Ekfd(Akm{A;K2v3K8C$LrnY&{;Sq$P2{1g4?D86R zpRR$?@^7lUtAU@~=|6v7p&gQFIiW%AZF{E_Ofz}(m|kd_|3`w+pD^9{?$>@t>PL0f zrB*Ei0W9|})MJa(C^eK&he`sVXdnUh6I8C7a*r3~vYnczuH19DKnTR;_c}p}0Xdu> zr2HtVSeb)oRvn$> z9vX2`N2ukA+`F>e`CRDPQKX8>2su6S%zFmnT`lygbjV1}n_aliPM!OwIyU3|2p7Zs zI!iah$yXn!ZqgVWnAW7DHXMlVIp zck|**O=P}!ISP!Q2mk|RoIq26@*-ay?$jkE69~^iF`tt{9GVB8SFOEXCvd^zmp1* z3VSbCx-3(5dT2wOK0NtHr;qncEDBd2oASS)MwG)tL9rhk|J7#o0YQyeK(X$rO#iBj z)Uzj>QT5$R`>8fjzx-8nVS$K{V7y(X^x;h>w9bMg^ebhmndi7?Yz{S}`X%MXlz-N& z%kb%buDDvBQhzUICuK#cXHIK9={k;FtM(9 zH8Byl<#!bnQILHLvLQj&ZE2H2SDqj-yo=zOQ%=avc)^ax}vjDVYDb*`< zbvHkrD(TrW-G(yuW6JNlMl2lDVckGhMt$VDqLTlXR)~zav*6jOIKO9rVP^SF z62tjRP^5cb=%j}~Qilmedf@KLOmvVb4{yi%bP@lvM}1!!C{CJeIeLAd-9JUvhYIRM zMMwTjH%GCbOIHy0umnS(Sf5+ZxKa1?c-ch=6^Bbh_8@9^O0VilRL2uM_s)m!=;cQE z{!hw+vZRE6GK;g&Q#A*MHwuJs@-aHR9Sc zFn5{(w{fk|lB^S!ivm$C?ioZa(}^Aa*vNV#l=TFx;P3;%vQ zvI4G z2|_oKh<*<536T(zwG-!rgRF`v@zhRK9Qrb)o0CT#L&lA&+iC1;oQem_x|;<{2DM`Y9>wf;<114lH-2wN#?BICvk#>t zzs7N%QL_%Lb<=(d6R1sMC_7<$>@g9x+g| zi;v*yi>kO^NUGzcV$ZqRi3$5b8!Q1c82)$+ei<4E(qmjrR>#y~NaBQmrU!UH*2fes z6SsT6e(UIrf3i$u0F_BaXlD7SkD~&GmQyhRCNKxtDDsQ0LG?ROhxS3IsITCoV`<p1G0{h{kqwaG}4mAiJc9|F- zeTw={^`RZOd%1<1s(v(eDa~#>0=F-ifUN!31zmnJ>a!6Lxd?C3K>e4RF;qv-YPT7zF9q*6U_AX`h!S3YQ-4ebJQ0Vq->HO%d;Hy*zPu9$Ov zvg%QnNw5E{kWVvj{2m0Tsf~BN$!5DDPq0ODpbT)-n~Y%NzETG93zclIDyiUBA^z6d z_g_C6RKK0t+sSWUUVAtMDuW~_YJ+EqG&4T-n zdlMaN_wTChNGM}Sf~g6k{`9oYUIH(WN&z2Bn;Iw}$~sb@3}bv=*}Pd#O9nFqg&?yE z&K(l}Lc{-lpEf!5VLv542$#WZ(Nc=!UqE5Z7IWTUn>eBkb})#v>5u#O2$JWFYT zdx(PN+jn^k4OJ5)M$pbM7j>RLJb(oyBKOapqpIhbummleuYaC+LB%G{|9$B~=1O^r z3~H>~(J+t1YWVu<4N>{LB9gFS^L6DnucywzjO3{8=CwroMa%Bg)Y74WgD(L=NWUE0 zz1?9+*p(+JgMoFO8zCL6q0LQ%;<*B}!!^k}S0S8!FNy2O{f}Si9bc&2ke%a7UUM4) zhz`wpJI(_$@*90Wn7nr36);`nVL+a(H&1#|ogTB6@^-JdGxgpv$W@>gyy=}5|HCDA zQ)GdsFK6|(t-446wLlTI=FrWHv2V}WLSqNdh--%kN-Sy2(2JF5`i%5XTpNG8oOXow zpbpdMqx6ah4GaV&209ty!67!`giEKgu=6pOH-j)$v)&IEy`@SJ{pnGiak|ov)!iNP zJDRr5p`vKiqnE&05+g&2p8Q!8|FBdK~xXI_hqIQfh`%%XMIY ze1yf1js6na8bB4AnIrB+l42gdZpbexIS@lt<)5Nihp3WvJF{R&K?`%B2SJ%q*k_#I zmV`ip%^7^tZ1Hab5T|=1*E4R@CFVbmA%`C&LQ#SZ0GR;Myu^^{O|5WEh^)bK@@7Tq zCyrIqApF0geo1|yFek(F;^*CSVLSBTIDSTJ*!ykKj1HWC zwfJvGv&n1IjZ5nPrY1I3DD4u;q>_Z3hd4n~1lB1=R5Px%O4U20+t#X!EdlbxQ{sCX z*dX{GcC;EkHvWA~Y21$KzSbbio>9~Qx9EXK{o5m6zeKidom{7;KB;`AaNc%-9Vt5^ z+A{krqOl~ci5x11QiTdWC&{^r-J~lI)B@NtA?vpzb}ff$>EXy25lzrbUkY=mvrUR~ zU=+6tt8LWv2tWgfRhOX5IlEkK*`wuqhjmE0rdcH8VVcENOq^l{h|McW4KPoQr--62 z&RgYq62?5k{h3`(wg8vuz}l!oFU%79GV;4N}n;B@I&uM5|{$D2||JR|( z|6j9||FiP{HDdWcfByeYVgB#KnNI{Tme4sS*_@i0W)~5`HX)4gAhl5}Z?^;pFQSk! zSejTSoW_=8JdPc%;Zl93won{nRn(7Bm^LvRye7YJ;lR8@cinKQMtI=HSF`2>rZcJ7 zw1OptOZMAXO`Z-kcY6BN%p-;B0mq#)~GIsEf;WMYU21-i|DZLyXA z-wTb_tDq5xsHw|>zR4jnT#)~N3O5gbHruz2cW6{%p){OpIT!_#U$L6`gB80Rj_ujuNf`-GVi0f=N?Ui+R=}}$p<*myE zQZg$SQO!(k>dO2HtD1oo_vE>p=?~KTIP52NYk86A&hbQ4&=7JrENv{!<2&*u!fYDi z^$&3_ZXC;VJU=6Vw*-Ju1iTiv_|{x=sqNhL8%8*f>$(daN<)>*T|%#c>s|iKY~GGL z5JG&N@3rziVT`Pm6s8zhQffk2cZsiaQUYzVs6U~Ocb)v#(}biBo{vb z0m35!q9H9Km#NI4^{*ED+w@U=0H(Du;uRr6UycYJh4+_@cF(EyFcD#nW%e;%FC5ih zPX{C>bMI(m0p5u>cLNP_d5l&YjV2il^Kz%by9NxFG*r8_$+z~^sS!0HI#Vy+&yCLw z{zvrEMw#WlX(bYvVu7344&EXO)Q!hpSrHtg%Tvs=%UFprY9%m{^6dki{9IFWZCZB= z$si%;U7&J%cGdPnG8@;=v%g-&P~||)R!y~zeLLQR^E1VZU@-6NvjtE>w%e+LYp0FQ znLWoic6chBEKK)dIBsimP!DwSniOybXm-g2d8ToxPyH?b$vU$54YNCLYC=gdlb!XM z&Tyy+MK)*K9i#R+I^%13;sASeW9FGc=sqP>p5iCB$SbhXR-IbBLpr69R_YmQMI|E0 zCEc+hrqUA+3lm`i)G)iX$DK5fM$FE5D-$sxkqookrPhOWV_IMb`DL(Qt7{T}vVjiE z6$%ger%~)ym=$dbiZ?Kd&1aJ6_j6 zMSl67lv2lGZA!um@z@iGF@l?=+d@$mdLi8ucvVAN)`+j0)a>&rq^OV$5qTUAw{@c2 z%-RfERVz!#;Zycj49#Xs(8$6EVPB9`Nr(a`3qvtTe(J)LvM(8L$dy1nMJdFZ*WEPC zZ)`!$Pi&pb^akPd<~(wSQl2jp3-oo(i-phD(Mzz?Kdw*W_-n8& zr1i7r7Nf-#$h>jdW~hLVgiYDJD|l~BTnlRWd7x;2lecOU##=L>rDLV_MpznnJZU4laLwnQZ> z?^OzvhX7fx*j!6pmT?l^Z-=qdN&|qGb<9w23`%jcc@E99HCC2M{UUhus~jw-)9-Pt z7jNWQpYMeBhl>wlU(o#V#LGj!Aqobjm)B^Hh?G~#a>31{y#!jSz_k2a3Zc{ESFXR= z9)m#;DA)GDpUtxjK^mdsLm6E&WEuj=i7+Tw42#8yXfFBi)WYi9pc8svw@eGhJXPwu za-R$Kq@n=GiXwY@ZL5Rlh&{GOTV%J48JV<9jSo$xkCdE+f@w5Jwj@+1op z`75TNl=t^6CQJik*m5s5XP>7gd296{!zY#i;IX~orSj2=X`isR{?;RvgHeu3euC8( z36yt%Mvh;c4Fsc>PH3>94rl7Qep!<&&5{%EqY2(rN3Ho2{4?{kY;P~R1CY$01fE&6 z9#G|bkk4X=pOd!~?L{rF32?O(Ph9XTY9w>h110|45j6W{+qHBtnF{cNZ}`8%DX+{r znz7?qZM{_MO&%T?t|5xT=Ef$kB!k(4(y|_}AAS$BW}F z*Hl<*O_8u~nZJ`Aox{iI$%Rqp-)?}1WdmEG*W+QiiU1$$$u?G07dhvK;qI`PBoRna zkzXvI?X>V4w||xcwfR@>!tONz{Wk0Puy?sohLbp9_+u(VCxu&%prA?y#Ll_!a#KB` z0CW1|MlgM&pn^#^bx?Z#(~WNp{Ifsq(jyqz^0uB5H}wY-d;Td}QDN}LdQ~IbjbTlr z4673utC#B08yQ?-xl!sFVbyl_$F+>dVXT-l9{hyDDSW>mEovJ!Y;mTEJIVojN_&8a zyZzJeM4pW?46qWxgYR{&46tga`m;mJzqylX<_}zxj26bn`UI+X*vY??n-+U+rpJZe z4U{+2IK6B_H5*KdSWqYD{{y}xjs%^OYt1`c#$h2oocb|uiiPkdXYtzBc?{6vd3 zb+$$sN7yklrq-^mK~$aZmOT}X$C z`wtOw9zOw(gPrW0%Rg}5vVz#|YfbgyyeHii-xSP&_x0EP!`ZVb%1wD)UBnphCF*Kw zO4Xd|{?rU?>O}Xd+|(O3!x5*QjW&^AO&pun8>E#Bn-Zq2 zcEgJZd#6vvXjSgDYygc0oI3cG)5Y%F(cyQtN4#XADQqu{RI>jbuRjYXi4K+<>~(H80*ba9Py>I{qs|RgIWoW25uL2I_q#3 zK=}vrEqFCM=I!Pi9?@et^4yDZms%2XkXY61e=nU#Q&p64!|#Z1r;}SRYkut|h?O4+ zo*v99gWkVfbmBV=_%Rqvp~FG!+sVAZJ=#peP+qxSw?r((EIC`GEtY^_l9gfHinctt zZTth4o&@Kv>(rx^U6wyCu;xw0d(x;(O+Ev-FR6c3J%$H~sL&<{7 zP@nHZaduMuv%fSVRm`TbOHYHPs7XY(E)NqPNNt}Vk1J181kxNvj6IWNAbH#&_X<&G z&jn59Zfb}L{2MCCp>lJcYc@$GY-1wDgkIg8GX)kU_Us&A6_i&4Fy~mc!Q}-tcNiEz zx#|vK#X!tMvRFxUOsCU5EF|F{Di_VCvP@fp3JziC+3Hu>pb zASFR(W-W!2S%?F%u;FwF|UsCjM*~g@2Q@Mu!csoPR z$s(a3Dco_mZY^XC@n#32RY5l|N&cPlbEu~*Oo)*}3_M7gdm2`3sfXEx4W9?3EanH? zOe^By$l};ow##2>wOZBmy>77KwUt72D0k{YTyb_AZ=6EgK%y9FH0zqVZJpslIDOTq z!dm9qs6l!cW0kkx^Wy)2coz6OhAqoV!hRd4_QZyDY;||xPxof2o{rpWtD+htW@%Ky zj5n*P!g|rhUw-H8xHKBNXYP-#5*HjWu+YErCqF50^0Xu+cJ9VA=aJJP>JdN9=rV8k z4htZ3279_YatW6k2pBFyFr$OyRF<5!qVFU!%x*_rO!CI*n~d(#Ut`Q^)PF5h=uK3o zrx$b;oPd%%%GPcYOVil~+ilE;v>N)$6G%&VemWvQsD$%wy8zqkRgNJ#%M5h+0H#XW zU=OSe>>7<^$0Kp;RJCixJXST{V0od}u41NO(fE%A@hw(i!Or$pQ=--$)diSli|1;W zkuP{AldCC^ku6`x_L35=7x+|&idmBmTV|Z+1RJeyeS!eAv{V%2As!)8(yXAjBCIVx zM%(h|gqEdKZc?;Pc#u=^KNfm$L83u=`umR+PXQf&+9=)R|6tWj>r@fmTuZ1<7v&G- zY@^XVz4FVy)v^r!o;InQd@|i4Ia;+6(~xye|MN@l1k_=wc+&d(f#TtV{m5{Xq><556R>}E@Q1SP&)KX>Gd>OeGT1kXwrX3_ovI(Mi1g@T2tA# z1CD!3MJ(HjeDZ%g<=ixD?5rt!H;vkGNLaTE-`Qkc2&6p;$1^p;)!MbQ83pj6H zHCOA6Rc(@t?D>2EQzx4^wqQ!+RA7+@1Gs3^jzODfQ{O>YLOrZhEeh~Cbv^Bvqcx2n zL7)%JUv?f^tDx%ABG*m>Ia%n}7*bDcyoIXY1g|lrJ`Ot1Db~q_g*=8JY`pn^<*1u9 zptqH3bPT4SkJE-jIW*^KW8O|H_HA_uj>^c3<=6epDrev(R~cv+j=;XUAq659m2S^~ zv}!VQBEnAJ^M%{CG%zBUR$em_;W0^1af3qOReazKcr#K4FR6RJpb^ti;w41<&cX<= zy%p&*KP7?=uJ*art35YYhI<&zsN_TqDwl!ih2KqXsX>J9WU8&#HTbKoU5>9z0lG*$ zoVA`Z%t5st^;?{Z=?mK3h24}i4o9d#9*f8k2D GQU3$^^uC4w literal 0 HcmV?d00001 diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..a988b8a --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +GNPy API : Optical Route Planning API +===================================================================== + +`GNPy `_ is an open-source, +community-developped API for GNPy library. + +tbd + +.. toctree:: + :maxdepth: 4 + + intro + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/intro.rst b/docs/intro.rst new file mode 100644 index 0000000..f47a1e9 --- /dev/null +++ b/docs/intro.rst @@ -0,0 +1,4 @@ +Introduction +============ + +tbd \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..8f9d537 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=python -msphinx +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=GNPyAPI + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The Sphinx module was not found. Make sure you have Sphinx installed, + echo.then set the SPHINXBUILD environment variable to point to the full + echo.path of the 'sphinx-build' executable. Alternatively you may add the + echo.Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..a7556a5 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,68 @@ +[metadata] +name = gnpyapi +description-file = README.md +description-content-type = text/markdown; variant=GFM +author = Telecom Infra Project +author-email = tbd +license = BSD-3-Clause +home-page = https://github.com/Telecominfraproject/oopt-gnpy-api +project_urls = + Bug Tracker = https://github.com/Telecominfraproject/oopt-gnpy-api/issues + Documentation = https://gnpyapi.readthedocs.io/ +python-requires = >=3.8 +classifier = + Development Status :: 5 - Production/Stable + Intended Audience :: Developers + Intended Audience :: Science/Research + Intended Audience :: Telecommunications Industry + License :: OSI Approved :: BSD License + Natural Language :: English + Programming Language :: Python + Programming Language :: Python :: 3 :: Only + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + Programming Language :: Python :: 3.10 + Programming Language :: Python :: 3.11 + Programming Language :: Python :: 3.12 + Programming Language :: Python :: Implementation :: CPython + Topic :: Scientific/Engineering + Topic :: Scientific/Engineering :: Physics + Topic :: System :: Networking +keywords = + optics + network + fiber + communication + route + planning + optimization + api + +[pbr] +warnerrors = True + +[files] +packages = gnpyapi + + +[options] +install_requires = + setuptools + gnpy==2.12.0 + flask>=1.1.2 + Flask-Injector + +[options.extras_require] +tests = + build>=1.0.3,<2 + pytest>=7.4.3,<8 + pyang>=2.6.1,<3 + +docs = + alabaster>=0.7.12,<1 + docutils>=0.17.1,<1 + myst-parser>=0.16.1,<1 + Pygments>=2.11.2,<3 + rstcheck + Sphinx>=5.3.0,<6 + sphinxcontrib-bibtex>=2.4.1,<3 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..e480b87 --- /dev/null +++ b/setup.py @@ -0,0 +1,5 @@ +#!/usr/bin/python3 + +import setuptools + +setuptools.setup(setup_requires=['pbr'], pbr=True) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..4265cc3 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1 @@ +#!/usr/bin/env python diff --git a/tests/test_api.py b/tests/test_api.py new file mode 100644 index 0000000..6adfa78 --- /dev/null +++ b/tests/test_api.py @@ -0,0 +1,10 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# @Author: Esther Le Rouzic +# @Date: 2025-02-03 + + +def test_sample(): + """Just for the ci + """ + assert True diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..fe88bb9 --- /dev/null +++ b/tox.ini @@ -0,0 +1,44 @@ +[tox] +skipsdist = True + +[testenv] +extras = tests +deps = + cover: pytest-cov + linters: flake8 + linters: pep8-naming + linters: mccabe + linters: flake8-noqa + linters-diff-ci: flake8-html +changedir = {toxinidir} +usedevelop = True +setenv = + cover: CI_COVERAGE_OPTS=--cov=gnpyapi --cov=tests --cov-report= +commands = + pytest {env:CI_COVERAGE_OPTS:} -vv {posargs} + cover: coverage html -d cover + cover: coverage xml -o cover/coverage.xml + python -m build + +[testenv:docs] +extras = docs +allowlist_externals = + /bin/sh +commands = + sphinx-build -E -W --keep-going -q -b html docs/ doc/build/html + /bin/sh -c "rstcheck --ignore-roles cite docs/*.rst" + +[testenv:linters] +commands = + flake8 {posargs} + +[testenv:linters-diff-ci] +allowlist_externals = bash +commands = + flake8 {posargs} --format html --htmldir linters --exit-zero + bash -c "git diff -U0 origin/$(git rev-parse --abbrev-ref HEAD) | flake8 --diff {posargs}" + +[flake8] +max-line-length = 120 +max-complexity = 15 +ignore = N806 W503