diff --git a/Dockerfile b/Dockerfile index 2b78d1f03..5d1b37306 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,7 +2,7 @@ FROM python:3 RUN mkdir -p /src COPY setup.py /src -COPY CHANGELOG.rst /src +COPY doc/CHANGELOG.rst /src COPY debian/ /src COPY src/ /src/lib/ diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 2c4e7ca1a..000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,101 +0,0 @@ - - -##### Summary - - -##### OS - -``` -Linux -MacOS -FreeBSD -Other (please specify) -``` - - -``` - -``` - -##### Version - -``` - -``` - -##### Installation - -``` -pip -pip with virtualenv -latest OS package -other (please specify) -``` - -##### Environment - - -``` - -``` - -##### Configuration - -``` - -``` - -##### Program output - -``` - -``` - -##### Steps to reproduce - -``` - -``` - -##### Importance - -``` - -``` diff --git a/PEP8 b/PEP8 deleted file mode 100644 index c18312335..000000000 --- a/PEP8 +++ /dev/null @@ -1,54 +0,0 @@ -PEP8 is Python coding standard. -http://www.python.org/dev/peps/pep-0008/ - -This code is not fully following PEP8, we do not enforce/follow the following : - W191 - use space for indentation - - I like three space for tabs, others like their code less compact, tabs are just great for that - - E101 - indentation using mix of tabs and space - - Obviously MUST be followed ... but ONE case : when aligning paramenters data over multiple lines. - The extra line should start with tabs to the point of indentation and finish with space, so the - alignment does not change when tabs spaces are changes (from 1 to 8 for example) - - E201 - whitespace after '{' - E202 - whitespace before ')' - E203 - whitespace before ',' - E211 - whitespace before '(' - E225 - missing whitespace around operator - E231 - E231 missing whitespace after ',' - - Function should be defined as : - def foo (param1, param2, param3): - and used calling - foo(param1,param2,param3) - - This makes search of function definition vs call must easier - This makes the reading of the function interface easier as well - - list can be clearer when defined as : - mylist = [ element1 , element2 , element3 ] - - E221 - multiple spaces before operator - E272 - for extraneous whitespace around keywords - - Sometimes it can make the code more readable to have aligned operation : - mostly if they are on the same line of a single if test - - - E302 - blank lines - E303 - blank lines - - This rule is too rigid, if two class are related, one blank can convey the idea - Three blank can be used to separate code more visibly - - E501 - line too long - - This is a good coding practice but warning messages to users violate that rule so ignored - in the file with long strings - - E701 - multiple statements on one line - - As python does not have switch, multiple if lines with only a one action are visually pleasing - diff --git a/CHANGELOG.rst b/doc/CHANGELOG.rst similarity index 100% rename from CHANGELOG.rst rename to doc/CHANGELOG.rst diff --git a/HISTORY.rst b/doc/HISTORY.rst similarity index 100% rename from HISTORY.rst rename to doc/HISTORY.rst diff --git a/README.rst b/doc/README.rst similarity index 100% rename from README.rst rename to doc/README.rst diff --git a/release b/release index da3fad7de..c3091c433 100755 --- a/release +++ b/release @@ -17,7 +17,7 @@ import zipapp import argparse -CHANGELOG = 'CHANGELOG.rst' +CHANGELOG = 'doc/CHANGELOG.rst' class Path: @@ -214,7 +214,7 @@ def release_github(args): Debian.set(release) print('updating ', end='') - for readme in ('README.md', 'README.rst'): + for readme in ('README.md', 'doc/README.rst'): print(readme + ' ', end='') with fileinput.FileInput(readme, inplace=True) as replacer: for line in replacer: diff --git a/setup.cfg b/setup.cfg index b38ce14be..e43a83388 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ author_email = thomas.mangin@exa-networks.co.uk url = https://github.com/Exa-Networks/exabgp version = attr: exabgp.version.version description = BGP swiss army knife -long_description = file: README.rst, CHANGELOG.rst +long_description = file: doc/README.rst, doc/CHANGELOG.rst keywords = BGP, ipv4, ipv6, mpls, vpls, flowspec, bgp-ls, SDN, HA, DDOS license = BSD 3-Clause License classifiers =