Свою социальную сеть на Питоне я делал весной 2020-го. Прошло почти 4 года. Код я выложил в открытом виде в своём гитхаб репозитории, но был вопрос, насколько его удобно использовать. Решил проверить.
Честно говоря, думал что будет у меня много проблем с тем, чтобы запустить код локально. Когда 4 года назад я клепал проект, то плохо понимал принципы работы гита, виртуального окружения, библиотек в нём. Поэтому весь проект собирался коряво, с установкой того же django локально, без некоторых принципов построения. Не хватало в то время структурированности обучения, ведь азы веб-программирования на Питоне я постигал методом научного тыка, случайными видеороликами, решением проблем гуглом и лишь бы оно работало. Подход возможный, проект собрался и даже до сих пор ждёт случайного любителя ананасов. Вот только есть проблема с тем, чтобы потом этот код хоть где-то применить или хотя бы запустить. Конкретно про запуск и речь.
Те библиотеки, которые в проекте использовал я не помнил. Поэтому, когда позавчера клонировал с гитхаба проект на комп, думал, что придётся потанцевать с бубном, чтобы запустить проект. Но нет. Установить оказалось достаточно лишь пару библиотек. Хотя, у меня нет уверенности, что это закроет все проблемы, может я просто не зашёл на страницу, где требовалась какая-то другая библиотека, или что-то подобное, и всё же локально всё запустилось. Поэтому я сделал файл с зависимостями requirements.txt. Делается он всего одной командой в консоли:
- pip freeze > requirements.txt
Теперь, если клонировать проект с гитхаба, можно установить все зависимости так же одной командой.
- pip install -r requirements.txt
А дальше добавил файл README.md, в котором все эти команды для локального запуска прописал. Не уверен, что правильно составляю этот файл, но думаю, что он немного поможет тем, кто захочет запустить проект. Во время написания статьи вспомнил, что могу туда закинуть ссылку на работающую версию сайта.
Вот такие минорные изменения репозитория спустя 4 года. Посмотрел на структуру проекта и понял, что теперь работать с ней не очень хочу. В код не залезал, наверное там мне будет страшно. Если вдруг совершенствовать проект, то я скорее буду его полностью переписывать с нуля. А главная суть этой статьи: важно в своих проектах формировать файлы requirements.txt и README.md, хотя бы для себя будущего.
Всем дочитавшим желаю заботиться о себе в будущем! И пусть в ваших делах всегда будет работающая структура!=)