From dcf3fa7be90ca2086b39fb4683ef6dc3421a7c45 Mon Sep 17 00:00:00 2001 From: Nao Ueda Date: Mon, 2 Nov 2020 20:59:33 +0900 Subject: add gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c5edab1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.envrc +.direnv/ -- cgit v1.2.3-54-g00ecf From 0f8a9964c397af38504532c11a148332da410784 Mon Sep 17 00:00:00 2001 From: Nao Ueda Date: Mon, 2 Nov 2020 20:59:43 +0900 Subject: use constant value --- ppad.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/ppad.py b/ppad.py index a4b50eb..338b37c 100755 --- a/ppad.py +++ b/ppad.py @@ -14,6 +14,7 @@ PAPERTRAIL_API_TOKEN = os.environ.get('PAPERTRAIL_API_TOKEN', None) ARCHIVES_URL = 'https://papertrailapp.com/api/v1/archives.json' DEFAULT_REMAIN_SIZE = 25 HEADERS = {'X-Papertrail-Token': PAPERTRAIL_API_TOKEN} +MIN_INTERVAL_SEC = 0.1 def get_ppheader(response): @@ -109,7 +110,7 @@ def main(): ) if len(future_list) < remain: - time.sleep(0.2) + time.sleep(MIN_INTERVAL_SEC) continue for future in future_list: @@ -127,7 +128,7 @@ def main(): remain = DEFAULT_REMAIN_SIZE continue - time.sleep(0.2) + time.sleep(MIN_INTERVAL_SEC) if __name__ == "__main__": -- cgit v1.2.3-54-g00ecf From fc4fa1f514caa16c9baafbdbadd0d1fe855db636 Mon Sep 17 00:00:00 2001 From: Nao Ueda Date: Mon, 2 Nov 2020 21:36:25 +0900 Subject: add license --- LICENSE | 343 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 343 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8f6897c --- /dev/null +++ b/LICENSE @@ -0,0 +1,343 @@ +Copyright (C) 2020 Nao Ueda + +---------------------------------------- + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. \ No newline at end of file -- cgit v1.2.3-54-g00ecf From d813bcb5b038e07db230813b084d24b6f1edc5ca Mon Sep 17 00:00:00 2001 From: Nao Ueda Date: Tue, 3 Nov 2020 19:21:03 +0900 Subject: change structure to distribute a package --- .gitignore | 7 +++ ppad.py | 135 ------------------------------------------------------- ppad/__init__.py | 129 ++++++++++++++++++++++++++++++++++++++++++++++++++++ ppad/__main__.py | 4 ++ pyproject.toml | 3 ++ setup.cfg | 27 +++++++++++ tests/.gitkeep | 0 7 files changed, 170 insertions(+), 135 deletions(-) delete mode 100755 ppad.py create mode 100755 ppad/__init__.py create mode 100644 ppad/__main__.py create mode 100644 pyproject.toml create mode 100644 setup.cfg create mode 100644 tests/.gitkeep diff --git a/.gitignore b/.gitignore index c5edab1..d5258fa 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,9 @@ +__pycache__/ + +build/ +dist/ +*.eggs +*.egg-info/ + .envrc .direnv/ diff --git a/ppad.py b/ppad.py deleted file mode 100755 index 338b37c..0000000 --- a/ppad.py +++ /dev/null @@ -1,135 +0,0 @@ -#!/usr/bin/env python3 - -import sys -import os -import time -import datetime -from concurrent import futures -import pytz -from dateutil import parser -import requests -import progressbar - -PAPERTRAIL_API_TOKEN = os.environ.get('PAPERTRAIL_API_TOKEN', None) -ARCHIVES_URL = 'https://papertrailapp.com/api/v1/archives.json' -DEFAULT_REMAIN_SIZE = 25 -HEADERS = {'X-Papertrail-Token': PAPERTRAIL_API_TOKEN} -MIN_INTERVAL_SEC = 0.1 - - -def get_ppheader(response): - hist = [response] + response.history - for h in hist: - if 'X-Rate-Limit-Remaining' not in h.headers: - continue - - return ( - int(h.headers['X-Rate-Limit-Limit']), - int(h.headers['X-Rate-Limit-Remaining']), - int(h.headers['X-Rate-Limit-Reset']) - ) - - -def do_download(url, filename, index): - while True: - try: - with requests.Session() as s: - res = s.get(url, headers=HEADERS) - finishtime = time.time_ns() - (limit, rem, reset) = get_ppheader(res) - - if 200 <= res.status_code < 300: - with open(filename, "wb") as f: - for chunk in res.iter_content(chunk_size=128): - f.write(chunk) - return (limit, rem, reset, finishtime, index) - except requests.ConnectionError: - time.sleep(1) - - -def parse_span(): - if len(sys.argv) == 1: - return None, None - - f = t = None - fromstr = tostr = '' - span = sys.argv[1].split('~') - if len(span) == 1: - fromstr = tostr = span[0] - else: - [fromstr, tostr, *_] = span - - if fromstr: - f = parser.isoparse(fromstr) - if not f.tzname(): - utc = pytz.timezone('UTC') - f = utc.localize(f) - - if tostr: - t = parser.isoparse(tostr) - if not t.tzname(): - utc = pytz.timezone('UTC') - t = utc.localize(t) - - if tostr and fromstr == tostr: - t = t + datetime.timedelta(days=1) - - return f, t - - -def main(): - if not PAPERTRAIL_API_TOKEN: - print('Not set the environment variable `PAPERTRAIL_API_TOKEN`', - file=sys.stderr) - sys.exit(1) - - _from, to = parse_span() - - r = requests.get(ARCHIVES_URL, headers=HEADERS) - r.raise_for_status() - - archives = [ar for ar in r.json() - if (not _from or _from <= parser.isoparse(ar["start"])) - and (not to or parser.isoparse(ar["end"]) < to) - ] - - with futures.ThreadPoolExecutor(max_workers=10) as executor: - future_list = [] - remain = DEFAULT_REMAIN_SIZE - until_reset_sec = 0 - lasttime = time.time_ns() - with progressbar.ProgressBar(max_value=len(archives)) as bar: - for i, ar in enumerate(archives): - future_list.append( - executor.submit( - do_download, - ar['_links']['download']['href'], - ar['filename'], - i - ) - ) - - if len(future_list) < remain: - time.sleep(MIN_INTERVAL_SEC) - continue - - for future in future_list: - (_, rem, reset, finishtime, index) = future.result() - if finishtime > lasttime: - remain = rem - until_reset_sec = reset - lasttime = finishtime - bar.update(index) - - future_list = [] - - if remain <= 0: - time.sleep(until_reset_sec) - remain = DEFAULT_REMAIN_SIZE - continue - - time.sleep(MIN_INTERVAL_SEC) - - -if __name__ == "__main__": - main() diff --git a/ppad/__init__.py b/ppad/__init__.py new file mode 100755 index 0000000..39be363 --- /dev/null +++ b/ppad/__init__.py @@ -0,0 +1,129 @@ +import sys +import os +import time +import datetime +from concurrent import futures +import pytz +from dateutil import parser +import requests +import progressbar + +PAPERTRAIL_API_TOKEN = os.environ.get('PAPERTRAIL_API_TOKEN', None) +ARCHIVES_URL = 'https://papertrailapp.com/api/v1/archives.json' +DEFAULT_REMAIN_SIZE = 25 +HEADERS = {'X-Papertrail-Token': PAPERTRAIL_API_TOKEN} +MIN_INTERVAL_SEC = 0.1 + + +def get_ppheader(response): + hist = [response] + response.history + for h in hist: + if 'X-Rate-Limit-Remaining' not in h.headers: + continue + + return ( + int(h.headers['X-Rate-Limit-Limit']), + int(h.headers['X-Rate-Limit-Remaining']), + int(h.headers['X-Rate-Limit-Reset']) + ) + + +def do_download(url, filename, index): + while True: + try: + with requests.Session() as s: + res = s.get(url, headers=HEADERS) + finishtime = time.time_ns() + (limit, rem, reset) = get_ppheader(res) + + if 200 <= res.status_code < 300: + with open(filename, "wb") as f: + for chunk in res.iter_content(chunk_size=128): + f.write(chunk) + return (limit, rem, reset, finishtime, index) + except requests.ConnectionError: + time.sleep(1) + + +def parse_span(): + if len(sys.argv) == 1: + return None, None + + f = t = None + fromstr = tostr = '' + span = sys.argv[1].split('~') + if len(span) == 1: + fromstr = tostr = span[0] + else: + [fromstr, tostr, *_] = span + + if fromstr: + f = parser.isoparse(fromstr) + if not f.tzname(): + utc = pytz.timezone('UTC') + f = utc.localize(f) + + if tostr: + t = parser.isoparse(tostr) + if not t.tzname(): + utc = pytz.timezone('UTC') + t = utc.localize(t) + + if tostr and fromstr == tostr: + t = t + datetime.timedelta(days=1) + + return f, t + + +def main(): + if not PAPERTRAIL_API_TOKEN: + print('Not set the environment variable `PAPERTRAIL_API_TOKEN`', + file=sys.stderr) + sys.exit(1) + + _from, to = parse_span() + + r = requests.get(ARCHIVES_URL, headers=HEADERS) + r.raise_for_status() + + archives = [ar for ar in r.json() + if (not _from or _from <= parser.isoparse(ar["start"])) + and (not to or parser.isoparse(ar["end"]) < to) + ] + + with futures.ThreadPoolExecutor(max_workers=10) as executor: + future_list = [] + remain = DEFAULT_REMAIN_SIZE + until_reset_sec = 0 + lasttime = time.time_ns() + with progressbar.ProgressBar(max_value=len(archives)) as bar: + for i, ar in enumerate(archives): + future_list.append( + executor.submit( + do_download, + ar['_links']['download']['href'], + ar['filename'], + i + ) + ) + + if len(future_list) < remain: + time.sleep(MIN_INTERVAL_SEC) + continue + + for future in future_list: + (_, rem, reset, finishtime, index) = future.result() + if finishtime > lasttime: + remain = rem + until_reset_sec = reset + lasttime = finishtime + bar.update(index) + + future_list = [] + + if remain <= 0: + time.sleep(until_reset_sec) + remain = DEFAULT_REMAIN_SIZE + continue + + time.sleep(MIN_INTERVAL_SEC) diff --git a/ppad/__main__.py b/ppad/__main__.py new file mode 100644 index 0000000..868d99e --- /dev/null +++ b/ppad/__main__.py @@ -0,0 +1,4 @@ +from . import main + +if __name__ == "__main__": + main() diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..9787c3b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools", "wheel"] +build-backend = "setuptools.build_meta" diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..d0a6241 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,27 @@ +[metadata] +name = ppad +version = 0.0.7 +url = https://github.com/nao0x2c6/ppad +author = Nao Ueda +author_email = nao.uedder@gmail.com +license_file = LICENSE +description = Papertrail log archives downloader +long_description = file: README.md +long_description_content_type = text/markdown +keywords = papertrail +classifiers = + License :: OSI Approved :: GNU General Public License v2 (GPLv2) + Programming Language :: Python :: 3.6 + +[options] +packages = find: +install_requires = + progressbar2 >= 3 + python-dateutil >= 2 + pytz >= 2020 + requests >= 2 + + +[options.entry_points] +console_scripts = + ppad = ppad:main diff --git a/tests/.gitkeep b/tests/.gitkeep new file mode 100644 index 0000000..e69de29 -- cgit v1.2.3-54-g00ecf From 28139ce2d8f03e8678fec8ab59622501480ab4a2 Mon Sep 17 00:00:00 2001 From: Nao Ueda Date: Tue, 3 Nov 2020 19:23:04 +0900 Subject: fix README --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b096a61..5257ad9 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,26 @@ # Papertrail log archives downloader +## Install + +Please use [pip](https://pip.pypa.io/) + +``` +pip install ppad +``` + ## Usage Please set your token to the environment variable named `PAPERTRAIL_API_TOKEN` to run the script. ```bash -$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ./ppad.py # Download all the log archives -$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ./ppad.py 2020-01-01~2020-02-01 # Download the archives which have logged January 2020 -$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ./ppad.py 2020-01-01~ # Specified the since date (including the since date file) -$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ./ppad.py ~2020-02-01 # Specified the until date (NOT including the until date file) +$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ppad # Download all the log archives +$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ppad 2020-01-01~2020-02-01 # Download the archives which have logged January 2020 +$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ppad 2020-01-01~ # Specified the since date (including the since date file) +$ PAPERTRAIL_API_TOKEN=YOUR_TOKEN ppad ~2020-02-01 # Specified the until date (NOT including the until date file) ``` +By running the above command(s), you can get the log archives named such as `2020-01-01-XX.tsv.gz` in the current directory. + The date format is ISO-8601 format supported. (The script uses [dateutil.isoparse](https://dateutil.readthedocs.io/en/stable/parser.html#dateutil.parser.isoparse)) -- cgit v1.2.3-54-g00ecf From cae02018b4ecd61fb8f2ee594775474c3f8f062f Mon Sep 17 00:00:00 2001 From: Nao Ueda Date: Tue, 3 Nov 2020 19:23:29 +0900 Subject: add requirements files --- requirements.in | 3 +++ requirements.txt | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 requirements.in create mode 100644 requirements.txt diff --git a/requirements.in b/requirements.in new file mode 100644 index 0000000..49acd0d --- /dev/null +++ b/requirements.in @@ -0,0 +1,3 @@ +progressbar +pytz +requests diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..fce2088 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,33 @@ +# +# This file is autogenerated by pip-compile +# To update, run: +# +# pip-compile --generate-hashes requirements.in +# +certifi==2020.6.20 \ + --hash=sha256:5930595817496dd21bb8dc35dad090f1c2cd0adfaf21204bf6732ca5d8ee34d3 \ + --hash=sha256:8fc0819f1f30ba15bdb34cceffb9ef04d99f420f68eb75d901e9560b8749fc41 \ + # via requests +chardet==3.0.4 \ + --hash=sha256:84ab92ed1c4d4f16916e05906b6b75a6c0fb5db821cc65e70cbd64a3e2a5eaae \ + --hash=sha256:fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691 \ + # via requests +idna==2.10 \ + --hash=sha256:b307872f855b18632ce0c21c5e45be78c0ea7ae4c15c828c20788b26921eb3f6 \ + --hash=sha256:b97d804b1e9b523befed77c48dacec60e6dcb0b5391d57af6a65a312a90648c0 \ + # via requests +progressbar==2.5 \ + --hash=sha256:5d81cb529da2e223b53962afd6c8ca0f05c6670e40309a7219eacc36af9b6c63 \ + # via -r requirements.in +pytz==2020.4 \ + --hash=sha256:3e6b7dd2d1e0a59084bcee14a17af60c5c562cdc16d828e8eba2e683d3a7e268 \ + --hash=sha256:5c55e189b682d420be27c6995ba6edce0c0a77dd67bfbe2ae6607134d5851ffd \ + # via -r requirements.in +requests==2.24.0 \ + --hash=sha256:b3559a131db72c33ee969480840fff4bb6dd111de7dd27c8ee1f820f4f00231b \ + --hash=sha256:fe75cc94a9443b9246fc7049224f75604b113c36acb93f87b80ed42c44cbb898 \ + # via -r requirements.in +urllib3==1.25.11 \ + --hash=sha256:8d7eaa5a82a1cac232164990f04874c594c9453ec55eef02eab885aa02fc17a2 \ + --hash=sha256:f5321fbe4bf3fefa0efd0bfe7fb14e90909eb62a48ccda331726b4319897dd5e \ + # via requests -- cgit v1.2.3-54-g00ecf