Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added setup.py for installing imapbackup38.py #47

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
# C extensions
*.so

# virtual environment
.venv

# Packages
*.egg
*.egg-info
Expand Down Expand Up @@ -37,3 +40,4 @@ nosetests.xml

# Things that might show up during testing
*.mbox

12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ imapbackup

A Python script for creating full backups of IMAP mailboxes

## Installation

Installation is provided for imapbackup38 (requires python3.8 and above)

```
pip install .

imapbackup38 -s IMAP_SERVER -u USER_NAME -d TARGET_DIR [OPTIONS]

```

## Background

This was first published around 2007 (probably earlier) [on my personal site][tao], and it was originally developed to work around the then rather limited (ok, inconsistent) Mac OS X Mail.app functionality and allow me to back up my old mailboxes in a fully standard `mbox` format (well, at least as much as `mbox` can be considered a standard...).
Expand All @@ -24,6 +35,7 @@ Somewhat to my surprise it was considered useful by quite a few people throughou
## Requirements

Python 2.x : `imapbackup.py` should work on Python 2.5 or any other 2.x version without any extra dependencies whatsoever.

Python 3.x : `imapbackup38.py` requires python 3.8 and above.

## Contributing
Expand Down
Empty file added requirements.txt
Empty file.
19 changes: 19 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
from setuptools import setup, find_packages

with open("requirements.txt", "r") as _f:
requirements = [line for line in _f.read().split("\n")]

setup(
name="imapbackup38",
description="A Python script for creating full backups of IMAP mailboxes",
packages=find_packages(),
author="Rui Carmo",
entry_points="""
[console_scripts]
imapbackup38=imapbackup38:main
""",
py_modules=["imapbackup38"],
install_requires=requirements,
version="0.0.1",
url="https://github.com/rcarmo/imapbackup",
)