[PR #65] [CLOSED] WIP: Create python package from repository #4067

New issue

Closed

opened 2026-03-15 01:24:19 +03:00 by kerem · 0 comments

kerem commented

2026-03-15 01:24:19 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/ArchiveBox/ArchiveBox/pull/65
Author: @edoput
Created: 1/20/2018
Status: ❌ Closed

Base: master ← Head: master

📝 Commits (10+)

f25d034 prepare directory for python packaging
1709c32 add python package setup
ff07658 rename directory in python friendly snake case
39ce92c fix relative import
a1a6ede add requests package to dependencies
febe5d2 switch configuration from python file to config parser
ae12f69 add configuration data to package
58bb3d4 fix typo in configuration name
2afe9fb remove unrecognised project_url value
b155e96 change user configuration file path

📊 Changes

20 files changed (+356 additions, -257 deletions)

View changed files

➖ archive (+0 -162)
➕ bin/archive (+124 -0)
➕ bin/archive-config (+37 -0)
📝 bookmark_archiver/__init__.py (+0 -0)
📝 bookmark_archiver/archive_methods.py (+4 -6)
➕ bookmark_archiver/config.py (+102 -0)
📝 bookmark_archiver/index.py (+5 -5)
📝 bookmark_archiver/links.py (+2 -2)
📝 bookmark_archiver/parse.py (+1 -1)
📝 bookmark_archiver/templates/index.html (+0 -0)
📝 bookmark_archiver/templates/index_row.html (+0 -0)
📝 bookmark_archiver/templates/link_index.html (+0 -0)
📝 bookmark_archiver/templates/link_index_fancy.html (+0 -0)
📝 bookmark_archiver/templates/static/archive.png (+0 -0)
📝 bookmark_archiver/templates/static/external.png (+0 -0)
📝 bookmark_archiver/templates/static/spinner.gif (+0 -0)
📝 bookmark_archiver/util.py (+1 -1)
➕ conf/user.conf (+48 -0)
➖ config.py (+0 -80)
➕ setup.py (+32 -0)

📄 Description

This will create a python package installable using pip.

The package can be later published on pypi for easier access.

Before merging I would squash everything into one commit if approved.

Scripts

the installation provide an archive command that will be available from the shell and will execute the archive.py script

Setup

The important part is the setup.py file as it contains metadata and instructions for pip.

I filled it with the information I could find and it should be ok but as you are the author please review it.

config.py

As this file is considered editable by the user maybe we should move it somewhere suitable (~/.config/bookmark-archiver/config.py) and access it at runtime.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/ArchiveBox/ArchiveBox/pull/65 **Author:** [@edoput](https://github.com/edoput) **Created:** 1/20/2018 **Status:** ❌ Closed **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (10+) - [`f25d034`](https://github.com/ArchiveBox/ArchiveBox/commit/f25d03490535e130c5381ed15a974127f19a5d60) prepare directory for python packaging - [`1709c32`](https://github.com/ArchiveBox/ArchiveBox/commit/1709c327520fefb7321b509f7f8c1b997ebfee48) add python package setup - [`ff07658`](https://github.com/ArchiveBox/ArchiveBox/commit/ff07658d645fa4632aaab7f0bd0f5ed34a30c8ba) rename directory in python friendly snake case - [`39ce92c`](https://github.com/ArchiveBox/ArchiveBox/commit/39ce92c1d4ddb0c44fea202bcd3e46a1cf243c38) fix relative import - [`a1a6ede`](https://github.com/ArchiveBox/ArchiveBox/commit/a1a6edeaab14d0b88791be6f76b54f272f4a55e2) add requests package to dependencies - [`febe5d2`](https://github.com/ArchiveBox/ArchiveBox/commit/febe5d24d3535eaa76b72628e8558d90144b395d) switch configuration from python file to config parser - [`ae12f69`](https://github.com/ArchiveBox/ArchiveBox/commit/ae12f69d9dee7d706d649b3c94933d41ac1ff445) add configuration data to package - [`58bb3d4`](https://github.com/ArchiveBox/ArchiveBox/commit/58bb3d4b4426c5b52b42553c5d431b06bafc0ac5) fix typo in configuration name - [`2afe9fb`](https://github.com/ArchiveBox/ArchiveBox/commit/2afe9fb031189a0ccb1e7815e50f36606c240a88) remove unrecognised project_url value - [`b155e96`](https://github.com/ArchiveBox/ArchiveBox/commit/b155e96235a3986e17f06cb09cd1a05d6e546143) change user configuration file path ### 📊 Changes **20 files changed** (+356 additions, -257 deletions) <details> <summary>View changed files</summary> ➖ `archive` (+0 -162) ➕ `bin/archive` (+124 -0) ➕ `bin/archive-config` (+37 -0) 📝 `bookmark_archiver/__init__.py` (+0 -0) 📝 `bookmark_archiver/archive_methods.py` (+4 -6) ➕ `bookmark_archiver/config.py` (+102 -0) 📝 `bookmark_archiver/index.py` (+5 -5) 📝 `bookmark_archiver/links.py` (+2 -2) 📝 `bookmark_archiver/parse.py` (+1 -1) 📝 `bookmark_archiver/templates/index.html` (+0 -0) 📝 `bookmark_archiver/templates/index_row.html` (+0 -0) 📝 `bookmark_archiver/templates/link_index.html` (+0 -0) 📝 `bookmark_archiver/templates/link_index_fancy.html` (+0 -0) 📝 `bookmark_archiver/templates/static/archive.png` (+0 -0) 📝 `bookmark_archiver/templates/static/external.png` (+0 -0) 📝 `bookmark_archiver/templates/static/spinner.gif` (+0 -0) 📝 `bookmark_archiver/util.py` (+1 -1) ➕ `conf/user.conf` (+48 -0) ➖ `config.py` (+0 -80) ➕ `setup.py` (+32 -0) </details> ### 📄 Description This will create a python package installable using *pip*. The package can be later published on pypi for easier access. Before merging I would squash everything into one commit if approved. ### Scripts the installation provide an `archive` command that will be available from the shell and will execute the `archive.py` script ### Setup The important part is the `setup.py` file as it contains metadata and instructions for pip. I filled it with the information I could find and it should be ok but as you are the author please review it. ### config.py As this file is considered editable by the user maybe we should move it somewhere suitable (`~/.config/bookmark-archiver/config.py`) and access it at runtime. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem

2026-03-15 01:24:19 +03:00

closed this issue
added the
pull-request
label

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/ArchiveBox#4067

No description provided.

Rows
Columns