/django-sftp

Django SFTP

Primary LanguagePythonMIT LicenseMIT

Django SFTP [WIP]

Tests Codecov PyPI Python Version Read the Docs License License pre-commit Dependabot

Features

  • TODO

Requirements

  • TODO

Getting Started

  1. Install django-sftp by pip.
$ pip install django-sftp
  1. Add it to your INSTALLED_APPS:
INSTALLED_APPS = (
   ...
   'django_sftp',
   ...
)
  1. Migrate app.
$ ./manage.py migrate
  1. Create user account.
$ ./manage.py createsuperuser --username user
  1. Create SFTP user group.
$ ./manage.py createsftpusergroup test
  1. Create SFTP account.
$ ./manage.py createftpuseraccount user test
  1. Generate RSA key
$ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" -m PEM
  1. Run SFTP server
$ ./manage.py sftpserver :11121 -k rsa

Usage

  • TODO

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT_ license, Django SFTP is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits